Decrypt

GET/api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Decrypt the value of a ciphertext property.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-decrypt-ciphertext.

Path parameters

ontology

string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

objectType

string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

primaryKey

string

The primary key of the object with the CipherText property.

property

string

The API name of the CipherText property. To find the API name for your CipherText property, check the Ontology Manager or use the Get object type endpoint.

Response body

DecryptionResult

object

Success response.

Hide child attributes

plaintext

string

optional

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/50030/ciphertexts/performance/decrypt"

Response

Copied!

{
  "plaintext": "Jane Doe"
}