POST API/Cryptography/RegisterCommonKey

DynamicApiのリクエスト/レスポンスの暗号化に使用する共通鍵を登録します。
共通鍵IDと暗号化に必要なパラメータを付加した共通鍵の情報を返します。

Request Information

URI Parameters

None.

Body Parameters

RSA暗号化されたキーを含む共通鍵の情報

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

暗号化パラメータを付加した共通鍵の情報

RegisterCommonKeyResponseViewModel
NameDescriptionTypeAdditional information
EncryptionAlgorithm

共通鍵アルゴリズム

CommonEncryptionAlgorithms

None.

CommonKeyId

共通鍵ID

string

None.

ExpirationDate

有効期限(UTC)

date

None.

IV

初期ベクター(Base64エンコード)

string

None.

KeySize

キーサイズ

integer

None.

CipherMode

Cipherモード

CipherMode

None.

PaddingMode

パディングモード

PaddingMode

None.

Response Formats

application/json

Sample:
{
  "EncryptionAlgorithm": "AES",
  "CommonKeyId": "sample string 1",
  "ExpirationDate": "2020-09-26T07:40:40.5759965+00:00",
  "IV": "sample string 3",
  "KeySize": 4,
  "CipherMode": "CBC",
  "PaddingMode": "None"
}

text/json

Sample:
{
  "EncryptionAlgorithm": "AES",
  "CommonKeyId": "sample string 1",
  "ExpirationDate": "2020-09-26T07:40:40.5759965+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>2020-09-26T07:40:40.5759965+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>2020-09-26T07:40:40.5759965+00:00</ExpirationDate>
  <IV>sample string 3</IV>
  <KeySize>4</KeySize>
  <PaddingMode>None</PaddingMode>
</RegisterCommonKeyResponseViewModel>