POST API/Cryptography/RegisterCommonKey

Registers the common key to be used to encrypt the DynamicAPI requests/responses.
Returns common key information along with necessary parameters for encryption.

Request Information

URI Parameters

None.

Body Parameters

Common key information including an RSA-encrypted key

Collection of byte

Request Formats

application/json

Sample: 
"QEA="

text/json

Sample: 
"QEA="

application/xml

Sample: 
<base64Binary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">QEA=</base64Binary>

text/xml

Sample: 
<base64Binary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">QEA=</base64Binary>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/octet-stream

Sample: 
@@

Response Information

Resource Description

Common key information including encryption parameters

RegisterCommonKeyResponseViewModel
NameDescriptionTypeAdditional information
EncryptionAlgorithm

Common key algorithm

 CommonEncryptionAlgorithms

None.
CommonKeyId

Common key ID

 string

None.
ExpirationDate

Expiration date (UTC)

 date

None.
IV

Initialization vector (Base64)

 string

None.
KeySize

Key size

 integer

None.
CipherMode

Cipher mode

 CipherMode

None.
PaddingMode

Padding mode

 PaddingMode

None.

Response Formats

application/json

Sample: 
{
  "EncryptionAlgorithm": "AES",
  "CommonKeyId": "sample string 1",
  "ExpirationDate": "2025-12-17T10:09:41.4101204+00:00",
  "IV": "sample string 3",
  "KeySize": 4,
  "CipherMode": "CBC",
  "PaddingMode": "None"
}

text/json

Sample: 
{
  "EncryptionAlgorithm": "AES",
  "CommonKeyId": "sample string 1",
  "ExpirationDate": "2025-12-17T10:09:41.4101204+00:00",
  "IV": "sample string 3",
  "KeySize": 4,
  "CipherMode": "CBC",
  "PaddingMode": "None"
}

application/xml

Sample: 
<RegisterCommonKeyResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JP.DataHub.ApiWeb.Models.Cryptography">
  <CipherMode>CBC</CipherMode>
  <CommonKeyId>sample string 1</CommonKeyId>
  <EncryptionAlgorithm>AES</EncryptionAlgorithm>
  <ExpirationDate>2025-12-17T10:09:41.4101204+00:00</ExpirationDate>
  <IV>sample string 3</IV>
  <KeySize>4</KeySize>
  <PaddingMode>None</PaddingMode>
</RegisterCommonKeyResponseViewModel>

text/xml

Sample: 
<RegisterCommonKeyResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JP.DataHub.ApiWeb.Models.Cryptography">
  <CipherMode>CBC</CipherMode>
  <CommonKeyId>sample string 1</CommonKeyId>
  <EncryptionAlgorithm>AES</EncryptionAlgorithm>
  <ExpirationDate>2025-12-17T10:09:41.4101204+00:00</ExpirationDate>
  <IV>sample string 3</IV>
  <KeySize>4</KeySize>
  <PaddingMode>None</PaddingMode>
</RegisterCommonKeyResponseViewModel>