Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListKeysRequest

example

Click here to see how to use ListKeysRequest.

Properties

Optional algorithm

algorithm: Algorithm

The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional curveId

curveId: CurveId

The curve ID of the keys. (This pertains only to ECDSA keys.)

Optional length

length: undefined | number

The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated "List" call.

Optional opcRequestId

opcRequestId: undefined | string

Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Optional page

page: undefined | string

The value of the {@code opc-next-page} response header from the previous "List" call.

Optional protectionMode

protectionMode: ProtectionMode

A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of {@code HSM} means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of {@code SOFTWARE} means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of {@code SOFTWARE} are performed on the server. A protection mode of {@code EXTERNAL} mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of {@code EXTERNAL} are performed by external key manager.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. You can specify only one sort order. The default order for {@code TIMECREATED} is descending. The default order for {@code DISPLAYNAME} is ascending.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).