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 (CTE-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • 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 Widows
  • 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

REST APIs

Create token for the plaintext

search

Please Note:

printsuggest an edit

Create token for the plaintext

copy link to clipboardtokenize()

This API tokenizes a plaintext value, and returns the token. User should have encrypt permission on the key to perform tokenization.

copy link to clipboardURL

https://localhost:8443/tmrestVaultless/SafeNetVaultlessTokenization/tokenize

copy link to clipboardURL for Batch

https://localhost:8443/tmrestVaultless/SafeNetVaultlessTokenization/tokenizeBatch

copy link to clipboardMethod

POST

copy link to clipboardParameters

The following parameters are required for tokenization of a plain text. Parameters are further classified into three main categories:

Common Parameters

ParameterDescription
naeUserKey manager's user with access to the key.
naePasswordKey manager's user password.
KeyNameKey to initialize the token service vaultless.
value(s)plaintext(s) to be tokenized.

TokenSpec Parameters

Allows users to set the parameters based on which the plaintext is tokenized/detokenized.

ParametersDescription
groupIDSets the group ID (long) for the plaintext to be tokenized.
luhnCheckDetermines whether the luhn digit of the token generated should pass or fail the luhnCheck.
nonIdempotentTokensDetermines if the same or different tokens are generated for the same input plaintext.
clearTextSensitiveDetermines if the digits in the clear-text position of the input plaintext is used to generate the token.
formatAllows user to set the structure of the token generated.

AlgoSpec Parameter

Provides the input for the algorithm used in tokenization/detokenization process.

ParameterDescription
versionThe possible values are 0 and 1. It is set to 1 to have higher security in tokenization/detokenization process. The default value is set to 1.
UnicodeThis parameter is used to tokenize and detokenize the Unicode input characters.

copy link to clipboardImportant Notes

  • If no values are specified for groupID, luhnCheck, nonIdempotentTokens, clearTextSensitive and format, their default values are used.

  • For clearTextSensitive and nonIdempotentTokens parameters, if any value other than true or false is specified, it is considered as false.

  • It is recommended to use the default value of AlgoSpec by setting “version”:1 in the JSON payload to ensure higher security in tokenization/detokenization process.

copy link to clipboardReturned Values

String or String[] - token(s) created for the input value(s).

copy link to clipboardThrows

TokenExceptions in case any parameter is invalid.

copy link to clipboardExamples

copy link to clipboardTokenization

Option 1

Request

{
"naeUser":"user",
"naePassword":"xxxxxxxx",
"value":"1000-0000-0023-4400-9",
"format":"TOKEN_ALL",
"keyName" :"vless_try"
}

Response

{
"token": "2373-0717-3541-2400-9"
}

Option 2

Request

{
"naeUser":"grp_user1",
"naePassword":"xxxxxxxx",
"value":"9971200625",
"format":"1",
"groupID":1,
"keyName" :"tm_vless_try",
"clearTextSensitive":false,
"version":1
}

Response

{
"token": "8299997805"
}

copy link to clipboardBatch Tokenization

Option 1

Request

{
"naeUser":"user",
"naePassword":"xxxxxxxx",
"values":["2333333333333333","222222222222233","444444444444433"],
"format":"TOKEN_ALL",
"keyName" :"vless_try"
}

Response

{
tokens: [3]
0: "2586314385333322"
1: "4302578582222225"
2: "6627979014444895"
}

Option 2

Request

{
"naeUser":"grp_user1",
"naePassword":"xxxxxxxx",
"values":["8299997805","9971200625"],
"format":"1",
"groupID":1,
"keyName" :"tm_vless_try",
"clearTextSensitive":false,
"version":1
}

Response

{
"tokens": [
"5564142810",
"8299997805"
]
}

copy link to clipboardTokenization of Unicode Characters

Option 1

Request

{
"naeUser":"user",
"naePassword":"xxxxxxxx",
"value":"ぁあぢぁあぢ",
"format":"1",
"groupID":1,
"keyName" :"tm_vless_try",
"clearTextSensitive":false,
"version":1,
"unicode":"HIRAGANA"
}

Response

{
"token": "だじしづほぶ"
}

copy link to clipboardBatch Tokenization of Unicode Characters

Request

{
"naeUser":"grp_user1",
"naePassword":"xxxxxxxx",
"values":[" ぁあぢぁあぢ"," ぁああぢ"],
"format":"1",
"groupID":1,
"keyName" :"tm_vless_try",
"clearTextSensitive":false,
"version":1,
"unicode":"HIRAGANA"
}

Response

{
"tokens": [
" だじしづほぶ",
" ゜ ゑんも"
]
}

On this page