Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Tenant/ Obtaining KMS Agency Authorization Status of the Current Tenant
Updated on 2026-05-12 GMT+08:00

Obtaining KMS Agency Authorization Status of the Current Tenant

Function

This API is used to obtain the KMS agency authorization status of the current tenant.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET https://{hostURL}/v4/tenants/{tenant_id}/repo-encryption/kms-grant

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Definition

Tenant ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token 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.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

tenant_id

String

Definition

Tenant ID.

Range

The value must contain 1 to 1,000 characters.

assumed

Boolean

Definition

Whether granted delegation and authorization.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/tenants/{tenant_id}/repo-encryption/kms-grant

Example Responses

Status code: 202

Obtain the KMS agency authorization status of the current tenant.

{
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "assumed" : true
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

202

Obtain the KMS agency authorization status of the current tenant.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.