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

Session Oriented APIS

Session_Date2_Request

search

Please Note:

printsuggest an edit

Session_Date2_Request

This API performs tokenization and detokenization of dates.

copy link to clipboardURL

./Session_Date2_Request

copy link to clipboardInput Parameters

ParametersDescription
keyNameName of the key to be used for tokenization and detokenization of dates.
dateFormatSchemeRepresents a possible set of date formats.
The supported date format schemes are:
  1. DDMMYYYY (includes all possible java date formats that consist of date, month, and year in four digits)
    The possible formats under this scheme can be dd/MM/yyyy, dd/MMM/yyyy, dd-MM-yyyy hh:mm:ss, and so on.
  2. DDMMYY (includes all possible java date formats that consist of date, month, and year in two digits)
    The possible formats under this scheme can be dd/MM/yy, dd-MM-yy hh:mm:ss, and so on.
  3. MMYYYY (includes all possible java date formats that consist of month and year in four digits)
    The possible formats under this scheme can be MM/yyyy, yyyy-MM, and so on.
  4. MMYY (includes all possible java date formats that consist of month and year in two digits)
    The posible formats under this scheme can be MM/yy, yy-MM, and so on.
dateFormatThe arrangements of date, month, and year are in a java format that aligns with the dateFormatScheme.
For example, the dateFormat of dd-MM-yyyy hh:mm:ss (03-Jun-2024 21:00:30) after tokenization has no impact on the time and the time remains unaltered, that is, 21:00:30.
note

Note

• The dateformat must align with the dateFormatScheme to avoid any errors during tokenization or detokenization.
• For backward compatibility, without preserve and dateFormatScheme, the following formats are supported:
— mm/dd/yyyy
— yyyy-MM-dd

caution

Caution

The week year format YYYY and YY are not supported. It may lead to incorrect tokenization or detokenization.

dataData (Date) on which tokenization/detokenization is to be performed.
startYearThe value of start year must be greater than 999 for yyyy dateFormat.
The value of start year lies in the range from 00-100 for yy dateFormat.
Optional, if preserve parameter is set to Year_Month or Year.
endYearMaximum value of end year is 9999 in yyyy dateFormat.
Maximum value of end year is 100 in yy dateFormat.
Optional, if preserve parameter is set to Year_Month or Year.
transformationModeTransformation mode. Supported modes are: tokenize and detokenize.
tweakDataOptional, if provided, the length of tweak data should be ≤ 256 characters.
The default value is empty string.
preserveRetains the specific part of data that remains unaltered after tokenization. The valid values are:
— NONE (Default)
— MONTH
— YEAR
— YEAR_MONTH
For example, if the date to tokenize is 15-05-2024 and preserve is set to YEAR, then output can be 27-10-2024, where the year (2024) remains unaltered.

Note

The startYear and endYear is mandatory if the preserve type is NONE

copy link to clipboardTokenization SOAP Sample

<prot:Session_Date2_Request>
   <keyName>tedx</keyName>
   <!--Optional:-->
   <dateFormatScheme>DDMMYYYY</dateFormatScheme>
   <dateFormat>yyyy-MM-dd</dateFormat>
   <data>2024-02-29</data>
   <transformationMode>tokenize</transformationMode>
   <!--Optional:-->
   <startYear>1950</startYear>
   <!--Optional:-->
   <endYear>2050</endYear>
   <!--Optional:-->
   <tweakData>1234567890987654321234567</tweakData>
   <!--Optional:-->
   <preserve>NONE</preserve>
</prot:Session_Date2_Request>

copy link to clipboardTokenization Output

Tokenized date that is 2024-02-05.

<ns2:Session_Date2_Response xmlns:ns2="http://dsws.org/protectappws/">2022-11-25</ns2:Session_Date2_Response>

copy link to clipboardDetokenization SOAP Sample

<prot:Session_Date2_Request>
   <keyName>tedx</keyName>
   <!--Optional:-->
   <dateFormatScheme>DDMMYYYY</dateFormatScheme>
   <dateFormat>yyyy-MM-dd</dateFormat>
   <data>2022-11-25</data>
   <transformationMode>detokenize</transformationMode>
   <!--Optional:-->
   <startYear>1950</startYear>
   <!--Optional:-->
   <endYear>2050</endYear>
   <!--Optional:-->
   <tweakData>1234567890987654321234567</tweakData>
   <!--Optional:-->
   <preserve>NONE</preserve>
</prot:Session_Date2_Request>

Note

To maintain backward compatibility with CADP for JAVA 8.16.0, dateFormatScheme is optional for below date formats:

  • MM/dd/yyyy

  • yyyy-MM-dd

copy link to clipboardDetokenization Output

Detokenized date that is 2024-01-29.

<ns2:Session_Date2_Response xmlns:ns2="http://dsws.org/protectappws/">2024-02-29</ns2:Session_Date2_Response>

copy link to clipboardReference

The specifications for the Date2 algorithm are listed here.

On this page