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

XML Development

Secret Management Operations

search

Please Note:

print

Secret Management Operations

Secrets are managed objects that can store user defined data. This data can be:

  • blob

  • password

  • seed

There are two types of objects used to store secrets:

  • Secret Object: It can have password or seed as the data type. The seed may be used for cryptographic operations in the future, which is why it is a separate type. The password is a convenient way to store simple text strings.

  • Opaque Object: It is of blob data type. It can be used to store arbitrary data.

Note

CipherTrust Manager's Network Attached Encryption (NAE) protocol only supports Opaques Objects for XML interface 6.1 or higher.

Secrets support many of the same attributes that keys do. They can be made un-deletable, support meta-data, etc. They also support most of the same lifecycle states as keys.

The XML Interface enables you to:

copy link to clipboardSecretObjectImportRequest

Import a secret object.

<SecretObjectImportRequest>
<ID>......</ID>
<ObjectName>......</ObjectName>
<ObjectData>......</ObjectData>
<ObjectDataType>......</ObjectDataType>
<Exportable/>
<Deletable/>
</SecretObjectImportRequest>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
ObjectDataData to be imported as an opaque object.
ObjectDataTypeData type of object.
NOTE: Currently, only opaque objects are supported.

copy link to clipboardSecretObjectImportResponse

Server response to SecretObjectImportRequest.

<SecretObjectImportResponse>
<ID>......</ID>
<Success>.....</Success>
<Fingerprint>......</Fingerprint>
<ObjectName>......</ObjectName>
</SecretObjectImportResponse>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
FingerprintContains the fingerprint of the secret object.
copy link to clipboardExample
<ID>123</ID>
<ObjectName>MySecret1234</ObjectName>
<ObjectData>ABCDEF</ObjectData>
<ObjectDataType>opaque</ObjectDataType>
<Exportable/>
<Deletable/>
</SecretObjectImportRequest>
<SecretObjectImportResponse>
<ID>123</ID>
<Success>true</Success>
<Fingerprint>970093678B182127</Fingerprint>
<ObjectName>MySecret1234</ObjectName>
</SecretObjectImportResponse>

copy link to clipboardSecretObjectExportRequest

Export a Secret Object.

<SecretObjectExportRequest>
<ID>......</ID>
<ObjectName>......</ObjectName>
</SecretObjectExportRequest>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.

copy link to clipboardSecretObjectExportResponse

Server response to SecretObjectExportRequest.

<SecretObjectExportResponse>
<ID>......</ID>
<Success>true</Success>
<ObjectName>......</ObjectName>
<ObjectData>......</ObjectData>
<ObjectType>......</ObjectType>
<Fingerprint>......</Fingerprint>
</SecretObjectExportResponse>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
ObjectDataThe data of the opaque object.
ObjectTypeData type of the object.
NOTE: Currently, only Opaque Objects are supported.
FingerprintContains the fingerprint of the secret object.
copy link to clipboardExample
<ID>123</ID>
<ObjectName>MySecret1234</ObjectName>
</SecretObjectExportRequest>
<SecretObjectExportResponse>
<ID>123</ID>
<Success>true</Success>
<ObjectName>MySecret1234</ObjectName>
<ObjectData>ABCDEFG</ObjectData>
<ObjectType>Opaque Object</ObjectType>
<Fingerprint>93BE4612C41D23AF</Fingerprint>
<ObjectLength>7</ObjectLength>
</SecretObjectExportResponse>

copy link to clipboardSecretObjectInfoRequest

Return information about a secret object.

<SecretObjectInfoRequest>
<ID>......</ID>
<ObjectName>......</ObjectName>
</SecretObjectInfoRequest>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.

copy link to clipboardSecretObjectInfoResponse

Server response to SecretObjectInfoRequest.

<SecretObjectInfoResponse>
<ID>......</ID>
<Success>......</Success>
<ObjectName>......</ObjectName>
<Fingerprint>......</Fingerprint>
<ObjectType>opaque</ObjectType>
<ObjectCreationDate>......</ObjectCreationDate>
<ObjectUpdatedAt>......</ObjectUpdatedAt>
<Exportable/>
<Deletable/>
</SecretObjectInfoResponse>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
FingerprintContains the fingerprint of the secret object.
ObjectTypeData type of the object.
NOTE: Currently, only Opaque Objects are supported.
ObjectCreationDateDate and time when the object was created.
ObjectUpdatedAtDate and time when the object was most recently updated.
copy link to clipboardExample
<SecretObjectInfoRequest>
<ID>123</ID>
<ObjectName>MySecret1234</ObjectName>
</SecretObjectInfoRequest>
<SecretObjectInfoResponse>
<ID>123</ID>
<Success>true</Success>
<ObjectName>MySecret1234</ObjectName>
<Fingerprint>970093678B182127</Fingerprint>
<ObjectType>Opaque Object</ObjectType>
<ObjectCreationDate>2020-02-07 07:07:02.231893 +0000 UTC</ObjectCreationDate>
<ObjectUpdatedAt>2020-02-07 07:07:19.787637 +0000 UTC</ObjectUpdatedAt>
<Exportable/>
<Deletable/>
</SecretObjectInfoResponse>

copy link to clipboardSecretObjectModifyRequest

Modify a secret object.

<SecretObjectModifyRequest>
<ID>.....</ID>
<ObjectName>.....</ObjectName>
<Owner>.....</Owner>
<Exportable/>
<Deletable/>
<NonExportable/>
<NonDeletable/>
</SecretObjectModifyRequest>

CAUTION!: Above example is for reference only. Following tagsmust not be specified together in a single request, as it causes errors:
• and
• and

ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
ExportableTo make the secret object exportable.
NonExportableTo make the secret object non-exportable.
DeletableTo make the secret object deletable.
NonDeletableTo make the secret object non-deletable.
OwnerSpecify an owner to modify the Owner for the Secret Object. The specified owner must already exist.

copy link to clipboardSecretObjectModifyResponse

Server response to SecretObjectModifyRequest.

<SecretObjectModifyResponse>
<ID>.....</ID>
<Success>.....</Success>
</SecretObjectModifyResponse>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.
ExportableTo make the secret object exportable.
NonExportableTo make the secret object non-exportable.
DeletableTo make the secret object deletable.
NonDeletableTo make the secret object non-deletable.
OwnerSpecify an owner to modify the Owner for the Secret Object. The specified owner must already exist.
copy link to clipboardExample 1
<SecretObjectModifyRequest>
<ID>test1</ID>
<ObjectName>Secret</ObjectName>
<Owner>james</Owner>
<Exportable/>
<Deletable/>
</SecretObjectModifyRequest>
<SecretObjectModifyResponse>
<ID>test1</ID>
<Success>true</Success>
</SecretObjectModifyResponse>
copy link to clipboardExample 2
<SecretObjectModifyRequest>
<ID>test1</ID>
<ObjectName>Secret</ObjectName>
<NonExportable/>
<NonDeletable/>
</SecretObjectModifyRequest>
<SecretObjectModifyResponse>
<ID>test1</ID>
<Success>true</Success>
</SecretObjectModifyResponse>

copy link to clipboardSecretObjectDeleteRequest

To delete a secret object.

<SecretObjectDeleteRequest>
<ID>...</ID>
<ObjectName>....</ObjectName>
</SecretObjectDeleteRequest>
ElementDescription
IDContains the user-specified request ID.
ObjectNameName of the secret object.

copy link to clipboardSecretObjectDeleteResponse

Server response to SecretObjectDeleteRequest.

<SecretObjectDeleteResponse>
<ID>.....</ID>
<Success>.....</Success>
</SecretObjectDeleteResponse>
Example:
<SecretObjectDeleteRequest>
<ID>Id</ID>
<ObjectName>Secret_Object_1</ObjectName>
</SecretObjectDeleteRequest>
<SecretObjectDeleteResponse>
<ID>Id</ID>
<Success>true</Success>
</SecretObjectDeleteResponse>

On this page