Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Management APIs/ CMK Importing Management/ Obtaining CMK Import Parameters
Updated on 2022-09-15 GMT+08:00
View PDF

Obtaining CMK Import Parameters

Function

This API enables you to obtain necessary parameters to import a CMK, including a CMK import token and a CMK encryption public key.

Constraints

  • The returned public key type is RSA_2048 by default.

URI

POST /v1.0/{project_id}/kms/get-parameters-for-import

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

key_id

Yes

String

CMK ID. It should be 36 bytes and match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f

wrapping_algorithm

Yes

String

Encryption algorithm of key materials. It can be:

  • RSAES_PKCS1_V1_5

  • RSAES_OAEP_SHA_1

  • RSAES_OAEP_SHA_256

sequence

No

String

36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

key_id

String

CMK ID.

import_token

String

Key import token.

expiration_time

String

Import parameter expiration time. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

public_key

String

Public key of the DEK material, in Base64 format.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "wrapping_algorithm" : "RSAES_OAEP_SHA_1"
}

Example Responses

Status code: 200

Request processing succeeded.

{
  "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
  "import_token" : "AACIBjY2ZTQxYjBmLTY3ZWItNDU4Ny04OTIxLWVhZXXX...",
  "expiration_time" : 1501578672,
  "public_key" : "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCXXX..."
}

Status code: 400

Invalid request parameters.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 403

Authentication failed.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 404

The requested resource does not exist or is not found.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Request processing succeeded.

400

Invalid request parameters.

403

Authentication failed.

404

The requested resource does not exist or is not found.

Error Codes

See Error Codes.

Parent topic: CMK Importing Management