Qodex.ai

Lists keys in the specified vault and compartment.

GET {{managementEndpoint}}/20180608/keys?compartmentId={{compartment_ocid}}&sortBy=TIMECREATED&sortOrder=DESC

Lists the master encryption keys in the specified vault and compartment.

As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

Request Params

KeyDatatypeRequiredDescription
compartmentIdstring(Required) The OCID of the compartment.
limitstringThe maximum number of items to return in a paginated "List" call.
pagestringThe value of the opc-next-page response header
from the previous "List" call.
sortBystringThe field to sort by. You can specify only one sort order. The default
order for TIMECREATED is descending. The default order for DISPLAYNAME
is ascending.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).
protectionModestringA key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A
protection mode of 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 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
SOFTWARE are performed on the server.
algorithmstringThe algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms.
lengthstringThe length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32.
curveIdstringThe curve ID of the keys. (This pertains only to ECDSA keys.)

HEADERS

KeyDatatypeRequiredDescription
opc-request-idstringUnique 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.
Acceptstring

RESPONSES

status: OK

[{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","displayName":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","lifecycleState":"UPDATING","vaultId":"\u003cstring\u003e","algorithm":"ECDSA","definedTags":{"consectetur_1d":{"in2b":{},"Lorem_3":{},"ipsum6":{}},"Duise34":{"anim6a":{}}},"freeformTags":{"essee":"\u003cstring\u003e","nulla_7":"\u003cstring\u003e","irure55":"\u003cstring\u003e","ut18":"\u003cstring\u003e"},"protectionMode":"HSM"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","displayName":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","lifecycleState":"BACKUP_IN_PROGRESS","vaultId":"\u003cstring\u003e","algorithm":"ECDSA","definedTags":{"ut5":{"in_bf_":{},"pariatur468":{}},"ipsum60":{"dolore17a":{},"pariatur2ae":{},"ut_197":{},"ullamcocd":{}},"voluptate_d":{"labore_6":{}},"labore4c8":{"sed29":{},"dolore1d":{}},"nisi_bce":{"commodo_f15":{}}},"freeformTags":{"labore_14_":"\u003cstring\u003e","velit_64":"\u003cstring\u003e","occaecat_7af":"\u003cstring\u003e"},"protectionMode":"SOFTWARE"}]