Retiring a Grant
Function
This API is used to retire grants. After grants are retired, the granted users do not have the permission to operate keys.
For example, user A grants user B the permission to operate key A and grants user C the permission to revoke the grant. In this case, all users can retire the grant. After the grant is retired, user B cannot use key A.
Only the following users can retire a grant:
User who created the grant
User who has been granted the retiring_principal permission
User who has been granted the grantee_principal permission if retire-grant is contained in the grant list
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:retireGrant
Permission_management
KeyId *
g:ResourceTag/<tag-key>
- kms:grant:retire
 
-
 
URI
POST /v1.0/{project_id}/kms/retire-grant
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Project ID  | 
      
Request Parameters
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         X-Auth-Token  | 
       
         Yes  | 
       
         String  | 
       
         User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         key_id  | 
       
         Yes  | 
       
         String  | 
       
         A 36-byte Key ID which matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f.  | 
      
| 
         grant_id  | 
       
         Yes  | 
       
         String  | 
       
         A 64-byte grant ID which matches the regular expression ^[A-Fa-f0-9]{64}$, for example, 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d.  | 
      
| 
         sequence  | 
       
         No  | 
       
         String  | 
       
         36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff  | 
      
Response Parameters
Status code: 200
Request succeeded.
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         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
Delete the grant (ID: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d) for the key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.
{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "grant_id" : "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"
}
  Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Delete the grant (ID: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d) for the 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  | 
         
          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.*; public class CancelSelfGrantSolution { 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(); CancelSelfGrantRequest request = new CancelSelfGrantRequest(); RevokeGrantRequestBody body = new RevokeGrantRequestBody(); body.withGrantId("7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d"); body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f"); request.withBody(body); try { CancelSelfGrantResponse response = client.cancelSelfGrant(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()); } } }  | 
        
Delete the grant (ID: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d) for the 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  | 
         
          # 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 = CancelSelfGrantRequest() request.body = RevokeGrantRequestBody( grant_id="7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d", key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f" ) response = client.cancel_self_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)  | 
        
Delete the grant (ID: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d) for the 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  | 
         
          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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kms.NewKmsClient( kms.KmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CancelSelfGrantRequest{} request.Body = &model.RevokeGrantRequestBody{ GrantId: "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d", KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f", } response, err := client.CancelSelfGrant(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.  | 
      
| 
         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  | 
       
         Failed to complete the request. The server receives an invalid response from the upstream server.  | 
      
| 
         504  | 
       
         Gateway timed out.  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot