Fetching OCI Keys
Use the get /v1/cckm/oci/keys
API to view the list of OCI keys. The results can be filtered using the query parameters.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authentication token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | Internal ID of the OCI key. |
key_name | string | Name of the OCI key. |
algorithm | string | Algorithm of the OCI key. |
length | integer | Length of the OCI key. |
key_id | string | ID of the OCI key. |
vault_name | string | OCI vault where the key resides. |
protection_mode | string | Protection mode of the key - HSM or SOFTWARE. |
job_config_id | string | ID of the scheduler job that will perform key rotation. |
lifecycle_state | string | Key state in its lifecycle. Possible states are: • CREATING • UPDATING • CANCELLING_DELETION • PENDING_DELETION • ENABLING • DISABLING |
tenancy | string | Name of the OCI tenancy. |
compartment_name | string | Name of the OCI compartment. |
vault_id | string | ID of the OCI vault. |
cckm_vault_id | string | ID of the CCKM vault. |
curve_id | string | Elliptic curve to be used to fetch the keys. Possible values are: • NIST_P256 • NIST_P384 • NIST_P521 |
gone | string | Fetches the key based on their existence in the cloud. |
region | string | Fetches the key by the Region (location). |
local_hyok_key_id | string | ID of the local OCI HYOK key. |
local_hyok_key_version_id | string | ID of the local OCI HYOK key version. |
local_key_store_id | string | ID of the local OCI key store. |
linked_state | boolean | Filter the results by the status of the link between CCKM and OCI Keys. |
key_material_origin | string | The source of the key material. The origin of the key can be: • cckm: Key material is created on CCKM. • native: Key material is created on the OCI cloud. • unknown: Source of the key material is unknown. It is different than CCKM and the native cloud. |
blocked | boolean | This field indicates whether the OCI key is blocked. The default is false. |
state | string | State of the OCI key. |
skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
sort | string | Comma-delimited list of properties to sort the results. |
Example Request
Example Response
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.