Help Center/Data Encryption Workshop/API Reference/APIs/Key Management APIs/DEK Management/Creating a PIN
Updated on 2025-09-15 GMT+08:00
View PDF

Creating a PIN

Function

This API is used to create a PIN, which is used to create and encrypt a DEK in the level-4 cryptography testing scenario.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/kms/create-pin

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.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

pin_type

No

String

PIN code type. The default value is CipherText. The value can be:

  • PlainText

  • CipherText

keystore_id

No

String

Keystore ID. If the ciphertext PIN is specified, the following content must be specified:

1: shared cluster on the management plane

2: shared cluster on the data plane (POD zone)

Others: exclusive to tenants

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pin

String

Created PIN.

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 returned by the error request

error_msg

String

Error information returned by the error request

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 12 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 14 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 502

Table 15 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 16 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 504

Table 17 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 18 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Example Requests

Specify the shared cluster on the management plane to create a PIN. The ciphertext PIN is returned.

{
  "pin_type" : "CipherText",
  "keystore_id" : "1"
}

Example Responses

Status code: 200

Request succeeded.

{
  "pin" : "020098009EEAFCE122CAA5927D2XXX..."
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request parameters.

401

Username and password are required for the requested page.

403

Authentication failed.

404

The resource does not exist.

500

Internal service error.

502

Request failed. The server has received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: DEK Management