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

Examples

Reveal data

search

Please Note:

printsuggest an editpdf paneldownload

Reveal data

Use the /v1/reveal API to reveal data. This API uses the POST method.

copy link to clipboardPrerequisites

This section assumes you have fulfilled the prerequisites.

copy link to clipboardSyntax

curl -X POST -H "Content-Type: application/json" -d '{"protection_policy_name": "<protection_policy>","protected_data": "<data_to_be_revealed>","username": "<user>","external_version": "<external_version>"}' <ip>:<port>/v1/reveal
curl -X POST -H "Content-Type: application/json" --header 'Authorization: Bearer JWT` -d '{"protection_policy_name": "<protection_policy>","protected_data": "<data_to_be_revealed>","username": "<user>","external_version": "<external_version>"}' <ip>:<port>/v1/reveal

Here, ip is the IP of the host machine where CRDP container is deployed and <port> is the port of CRDP container.

copy link to clipboardRequest Parameters

Request ParameterDescription
Authorization HeaderAuthorization token (JWT). Required only when JWT verification for CRDP is enabled on the Application Data Protection UI.
protection_policy_nameProtection policy to be used during the reveal operation.
protected_dataData to be revealed.
usernameName of the user for whom data will be revealed. The reveal format will depend on the access policy selected while creating protection policy. If username is null or blank, the default reveal format will be used.
note

Note

Username is ignored if the Enable JWT Verification toggle is turned on and Username location in JWT is provided on the CipherTrust Manager.

external_versionRequired only when protection policy with external versioning is used in the reveal operation.

copy link to clipboardResponse Parameters

Response ParameterDescription
dataThe output can be plaintext, ciphertext, error replacement value, or masked value based on the reveal format configured for the user in access policy.
messageOnly applicable when reveal operation fails. This field stores the error message for failed operations.

Below table shows examples for different reveal formats supported in CRDP:

ExampleUserReveal FormatProtection Policy Versioning
Example 1user1PlaintextInternal
Example 2user2CiphertextInternal
Example 3user3Error Replacement Value (null)Disabled
Example 4user4Masked ValueExternal

copy link to clipboardExample 1

Request

curl --location 'http://10.0.x.x:8090/v1/reveal' --header 'Content-Type: application/json' --data '{ "protection_policy_name": "testpp-internal-versioned","protected_data": "10010008484-4992-0056-6749", "username": "user1"}'

Response

{
    "data": "1234-5678-9874-5632"
}

In this example, plaintext (1234-5678-9874-5632) is returned in the data field.

copy link to clipboardExample 2

Request

curl --location 'http://10.0.x.x:8090/v1/reveal' --header 'Content-Type: application/json' --data '{ "protection_policy_name": "testpp-internal-versioned","protected_data": "10010008484-4992-0056-6749", "username": "user2"}'

Response

{
    "data": "10010008484-4992-0056-6749"
}

In this example, output of the reveal operation is returned as the protected_data (10010008484-4992-0056-6749).

copy link to clipboardExample 3

Request

curl --location 'http://10.0.x.x:8090/v1/reveal' --header 'Content-Type: application/json' --data '{ "protection_policy_name": "testpp-disabled-versioned","protected_data": "8484-4992-0056-6749", "username": "user3"}'

Response

{
    "data": null
}

In this example, output of the reveal operation is returned as null.

copy link to clipboardExample 4

Request

curl --location 'http://10.0.x.x:8090/v1/reveal' --header 'Content-Type: application/json' --data '{ "protection_policy_name": "testpp-external-versioned","protected_data": "8484-4992-0056-6749", "external_version": "1001000", "username": "user4"}'

Response

{
    "data": "XXXX-XXXX-XXXX-5632"
}

In this example, output of the reveal operation is returned as a masked value (XXXX-XXXX-XXXX-5632). The masking format configured in access policy is SHOW_LAST_FOUR.

On this page