Viewing OCI Vaults Added to CipherTrust Manager
Use the get /v1/cckm/oci/vaults
API to view the list of OCI vaults added to the CipherTrust Manager.
Syntax
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authentication token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | Resource ID of the OCI vault. |
display_name | string | Display the name of the OCI vault. |
vault_name | string | Name of the vault. |
linked_state | boolean | Filter the results by the status of the link between CCKM and OCI vaults. |
issuer_id | string | ID of the issuer. |
state | string | State of the OCI vault. |
external_vault_type | string | Type of the OCI external vault. |
cloud_name | string | Name of the cloud. |
vault_id | string | ID of the OCI vault. |
vault_type | string | Type of the OCI vault. Valid values are DEFAULT , EXTERNAL , and VlRTUAL_PRlVATE . |
tenancy | string | Name of the OCI tenancy. |
compartment_name | string | Name of the OCI compartment. |
lifecycle_state | string | Vault state in its lifecycle. Possible states are: • CREATING • UPDATING • CANCELLING_DELETION • PENDING_DELETION • ENABLING • DISABLING |
region | string | Fetches the key by the Region (location). |
blocked | boolean | This field indicates whether the OCI key is blocked. The default is false. |
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
The sample output shows the list of OCI vaults added to the CipherTrust Manager.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.