Adding OCI Vaults
Use the post /v1/cckm/oci/add-vaults API to add an OCI vault to the CipherTrust Manager as a container.
Syntax
curl -k '<IP>/api/v1/cckm/oci/add-vaults' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "connection": "<oci-connection-name>",\n "region": "<oci-region>",\n "vault_id": [\n "<oci-vault-id>"\n ]\n}' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
| connection | string | Name or ID of the OCI connection. |
| region | string | Name of the OCI region where the vault is to be added. |
| vault_id | array of strings | List of IDs of the OCI vaults to be added. |
| bucket_name | string | Name of the OCI bucket for creating key backups of HSM-protected keys for Virtual Private Vaults (VPVs). The bucket should be in the same region as the vault. You must have appropriate read/write permissions on this bucket. |
| bucket_namespace | string | Namespace of the OCI bucket, bucket_name. This parameter is required if bucket_name is specified. |
If bucket_name and bucket_namespace are not specified, the keys cannot be backed up while syncing vaults.
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/oci/add-vaults' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZjJhZGFiYS0xNDNmLTRiZDYtOTQzMy1jYmZmYzBjMTgxZWUiLCJzdWIiOiJsb2NhbHw2ODNiOGUyYi04NGI1LTQ5MTYtYTMwMy00MDI0NDMyODA0N2QiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiMThmOGVjNjEtZWViMC00ODVlLTgwZjktZmJkY2UyZGY5MjI3Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImQ4ZjlkNjAwLTUyNjktNGJmNy05MDUyLTM3OWE5ZDU0OWI4MyIsImlhdCI6MTY0MTc4MTk3MiwiZXhwIjoxNjQxNzgyMjcyfQ.1Bh52JYqmawIRk3xfl0dnZsMXdc5VR4XtN4rfYQiAHs ' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "connection": "OCI Connection",\n "vault_id": [\n "ocid1.vault.oc1.iad.bzq26sunaaeuk.abuwcljta35dmgawsedrftgyhujikolkl7pmfn7q6wogbigjryu4udtkinnkmyacrq"\n ]\n}' --compressed
Example Response
{
"id": "ec063f80-91a9-4ec2-82e1-162c7648c547",
"uri": "kylo:kylo:cckm:oci-vault:ec063f80-91a9-4ec2-82e1-162c7648c547",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2022-01-24T04:46:16.317851881Z",
"updatedAt": "2022-01-24T04:46:16.317851946Z",
"vaults": [
{
"id": "952d22dd-518a-4544-91b5-de110533107d",
"uri": "kylo:kylo:cckm:oci-vault:952d22dd-518a-4544-91b5-de110533107d",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2022-01-24T04:46:16.313831149Z",
"updatedAt": "0001-01-01T00:00:00Z",
"compartment_id": "ocid1.tenancy.oc1..aaaaaaaadixb52awsedrftgyhujikol5aaal6hb2vg7audpd4d4mcf5zluymff6sq",
"display_name": "CCKM-Testing",
"vault_id": "ocid1.vault.oc1.iad.bzq26sunaaeuk.abuwcljta35dmgawsedrftgyhujikolkl7pmfn7q6wogbigjryu4udtkinnkmyacrq",
"lifecycle_state": "ACTIVE",
"management_endpoint": "https://bzqawsedrftgyhujikoleuk-management.kms.us-ashburn-1.oraclecloud.com",
"time_created": "2021-12-07T11:50:37.691Z",
"connection": "oci-connection",
"vault_type": "DEFAULT",
"wrappingkey_id": "ocid1.key.oc1.iad.bzqawsedrftgyhujikoluk.abuwcljstmeawsedrftgyhujikoltrlw6tqwqic7mgcbv7chsv7myhpnusyk3zq",
"is_primary": true,
"tenancy": "gemaltoproductdev",
"region": "us-ashburn-1"
}
]
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.