Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

External Vaults APIs

Creating an External vault

search

Please Note:

You are not viewing the most recent version of this page. 2.19 is the latest version available.

print

Creating an External vault

Use the post /v1/cckm/oci/create-external-vault API to create an external vault.

copy link to clipboardSyntax

curl -k 'https://127.0.0.1/api/v1/cckm/oci/create-external-vault' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n  "vault_name": <vault_name>,\n  "endpoint_url_hostname": <endpoint_url_hostname>,\n  "compartment_id": <compartment_id>,\n  "issuer_id": <issuer_id>,\n  "client_application_id": <client_application_id>\n}' --compressed

copy link to clipboardRequest Parameters

ParameterTypeDescription
AUTHTOKENstringAuthentication token.
compartment_idstringID of the Oracle compartment.
endpoint_url_hostnamestringIP address of the CipherTrust Manager or Load Balancer. FQDNs are not supported.
issuer_idstringID of the issuer.
client_application_idstringID of the OCI KMS application as registered on the third-party identity provider.
vault_namestringName of the external vault.
connectionstringName or ID of the Oracle connection on the CipherTrust Manager.
source_key_tierstringTier of the source. Specify the type of key source allowed in the vault. Possible option is local (CipherTrust Manager).
If the source_key_tier is not specified, you can create local keys in the vault.
policystringRego policy to be associated with the vault.

copy link to clipboardExample Request

curl -k 'https://52.86.120.81/api/v1/cckm/oci/create-external-vault' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n  "vault_name": "oci-external-vault-one",\n  "endpoint_url_hostname": "localhost",\n  "compartment_id": "ocid1.tenancy.oc1..aaaaaaaadixb52q2mvlsn634ql5aaal6hb2vg7audgd4dt4mcf6zluymff6sq",\n  "issuer_id": "95e0d83c-c408-42c7-b3f2-c86cd6bcda51",\n  "client_application_id": "kco-5e0d83c-c408-42c7-b3f2-c86cd6bcda56"\n}' --compressed

copy link to clipboardExample Response

{
    "id": "37900289-47cf-4172-91c5-7ea6cb87c4b7",
    "uri": "kylo:kylo:cckm:oci-vault:37900289-47cf-4172-91c5-7ea6cb87c4b7",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2022-06-27T08:50:28.011605208Z",
    "updatedAt": "0001-01-01T00:00:00Z",
    "vault_name": "oci-external-vault-one",
    "connection": "oci-connection",
    "endpoint_url_hostname": "localhost",
    "compartment_id": "ocid1.tenancy.oc1..aaaaaaaadixb52q2mvlsn634ql5aaal6hb2vg7audgd4dt4mcf6zluymff6sq",
    "issuer_id": "95e0d83c-c408-42c7-b3f2-c86cd6bcda51",
    "client_application_id": "kco-5e0d83c-c408-42c7-b3f2-c86cd6bcda56",
    "time_created": "2022-02-28T23:18:12.263Z",
    "compartment_name": "tenancy",
    "endpoint_url": "https://localhost/api/v1/cckm/oci/external-vaults/65e0d83c-c408-42c7-b3f2-c86cd6bcda51",
    "local_key_store_id": "65e0d83c-c408-42c7-b3f2-c86cd6bcda51",
    "linked_state": false,
    "cloud_name": "oci",
    "external_vault_type": "local",
    "tenancy": "tenancy"
}

copy link to clipboardResponse Codes

Response CodeDescription
2xxSuccess
4xxClient errors
5xxServer errors

Refer to HTTP status codes for details.

On this page