Updated on 2026-06-09 GMT+08:00

Creating a Grant

Function

This API is used to create a grant. Granted users can perform operations on the granted keys. The service default CMK whose suffix is /default cannot be granted.

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:cmk:createGrant

    Permission_management

    KeyId *

    • kms:KeyOrigin

    • kms:KeySpec

    • kms:KeyUsage

    • kms:MultiRegionKeyType

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    kms:grant:create

    -

    -

    • kms:GranteePrincipalType

    • kms:GrantOperations

    • kms:GranteePrincipal

    • kms:RetiringPrincipal

URI

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

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

key_id

Yes

String

Definition

Key ID

Constraints

  • The value must be a 36-byte ID.

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

Range

N/A

Default Value

N/A

grantee_principal

Yes

String

Definition

Granted user ID

Constraints

  • The value must contain 1 to 64 bytes.

  • The value must match the regular expression ^[a-zA-Z0-9]{1,64}$.

Range

N/A

Default Value

N/A

operations

Yes

Array of strings

Definition

List of granted operations

Constraints

The value cannot contain only create-grant.

Range

  • create-datakey: Create a DEK.

  • create-datakey-without-plaintext: Create a plaintext-free DEK.

  • encrypt-datakey: Encrypt a DEK.

  • decrypt-datakey: Decrypt a DEK.

  • describe-key: Query key information.

  • retire-grant: Retire a grant.

  • encrypt-data: Encrypt data.

  • decrypt-data: Decrypt data.

Default Value

N/A

name

No

String

Definition

Grant name

Constraints

  • The value must contain 1 to 255 characters.

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

Range

N/A

Default Value

N/A

retiring_principal

No

String

Definition

ID of the user who can retire a grant

Constraints

  • The value must contain 1 to 64 bytes.

  • The value must match the regular expression ^[a-zA-Z0-9]{1,64}$.

Range

N/A

Default Value

N/A

grantee_principal_type

No

String

Definition

Grant type

Constraints

N/A

Range

  • user: Grant to a sub-user.

  • domain: Grant to a tenant account.

Default Value

user

sequence

No

String

Definition

A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

grant_id

String

Definition

Grant ID

Range

N/A

Example Requests

Grant user 13gg44z4g2sglzk0egw0u726zoyzvrs8 with permission to query, create, and encrypt a key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "operations" : [ "describe-key", "create-datakey", "encrypt-datakey" ],
  "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8",
  "grantee_principal_type" : "user",
  "retiring_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8"
}

Example Responses

Status code: 200

Request succeeded.

{
  "grant_id" : "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"
}

SDK Sample Code

The SDK sample code is as follows.

Grant user 13gg44z4g2sglzk0egw0u726zoyzvrs8 with permission to query, create, and encrypt a key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kms.v2.region.KmsRegion;
import com.huaweicloud.sdk.kms.v2.*;
import com.huaweicloud.sdk.kms.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateGrantSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KmsClient client = KmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KmsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateGrantRequest request = new CreateGrantRequest();
        CreateGrantRequestBody body = new CreateGrantRequestBody();
        List<String> listbodyOperations = new ArrayList<>();
        listbodyOperations.add("describe-key");
        listbodyOperations.add("create-datakey");
        listbodyOperations.add("encrypt-datakey");
        body.withGranteePrincipalType(CreateGrantRequestBody.GranteePrincipalTypeEnum.fromValue("user"));
        body.withRetiringPrincipal("13gg44z4g2sglzk0egw0u726zoyzvrs8");
        body.withOperations(listbodyOperations);
        body.withGranteePrincipal("13gg44z4g2sglzk0egw0u726zoyzvrs8");
        body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f");
        request.withBody(body);
        try {
            CreateGrantResponse response = client.createGrant(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Grant user 13gg44z4g2sglzk0egw0u726zoyzvrs8 with permission to query, create, and encrypt a key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkms.v2.region.kms_region import KmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkms.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateGrantRequest()
        listOperationsbody = [
            "describe-key",
            "create-datakey",
            "encrypt-datakey"
        ]
        request.body = CreateGrantRequestBody(
            grantee_principal_type="user",
            retiring_principal="13gg44z4g2sglzk0egw0u726zoyzvrs8",
            operations=listOperationsbody,
            grantee_principal="13gg44z4g2sglzk0egw0u726zoyzvrs8",
            key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f"
        )
        response = client.create_grant(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Grant user 13gg44z4g2sglzk0egw0u726zoyzvrs8 with permission to query, create, and encrypt a key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := kms.KmsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kms.NewKmsClient(hcClient)

    request := &model.CreateGrantRequest{}
	var listOperationsbody = []string{
        "describe-key",
	    "create-datakey",
	    "encrypt-datakey",
    }
	granteePrincipalTypeCreateGrantRequestBody:= model.GetCreateGrantRequestBodyGranteePrincipalTypeEnum().USER
	retiringPrincipalCreateGrantRequestBody:= "13gg44z4g2sglzk0egw0u726zoyzvrs8"
	request.Body = &model.CreateGrantRequestBody{
		GranteePrincipalType: &granteePrincipalTypeCreateGrantRequestBody,
		RetiringPrincipal: &retiringPrincipalCreateGrantRequestBody,
		Operations: listOperationsbody,
		GranteePrincipal: "13gg44z4g2sglzk0egw0u726zoyzvrs8",
		KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
	}
	response, err := client.CreateGrant(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.