Updated on 2026-08-25 GMT+08:00

Creating a Key Policy

Function

This API is used to create a key policy.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    kms:policy:create

    Write

    policy *

    -

    -

    -

URI

POST /v1.0/{project_id}/kms/key-policies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keyspace_id

Yes

String

Definition

ID of the trusted key space to which the key policy belongs

Constraints

The value must match the regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$.

Range

N/A

Default Value

N/A

policy_name

Yes

String

Definition

Policy name

Constraints

The value must match the regular expression ^[a-zA-Z0-9:/_-]{1,255}$.

Range

1-255

Default Value

N/A

policy

Yes

String

Definition

Key policy

Constraints

The value must be a converted JSON string.

Range

N/A

Default Value

N/A

description

No

String

Definition

Key policy description

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

policy_id

String

Definition

Key policy ID

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

201

Request succeeded.

Error Codes

See Error Codes.