Updated on 2025-10-16 GMT+08:00

Authorization Operations

Function

This API is used to authorize operations.

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, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/csms/grants

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

Token of the authenticated user.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Resource ID.

type

Yes

String

Resource type, which can be SECRET or GROUP.

grantee_type

Yes

String

Authorized type, which can be 0 (user) or 2 (group).

grantee_target_id

Yes

String

Authorized ID.

validity_time

No

String

Expiration time.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

uuid

String

Authorization ID, which is available when the authorization is granted to an individual.

resourceId

String

Resource ID.

type

String

Authorization type, which can be SECRET or GROUP.

granteeUser

String

Authorized user ID.

createTime

Long

Creation time.

updateTime

Long

Update time.

validityTime

Long

Validity period.

state

Integer

Status.

signature

String

Signature.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 502

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 504

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Example Requests

{
  "resource_id" : "demo",
  "type" : "group",
  "grantee_type" : "0",
  "grantee_target_id" : "user_01"
}

Example Responses

Status code: 200

Authorization response.

{
  "data" : {
    "uuid" : "1c087a48-0d48-4222-9d34-ae43d30b27d2",
    "type" : "SECRET",
    "resourceId" : "43d643d2-95ec-4b0f-8020-a84f3ce931cc",
    "granteeUser" : "user_01",
    "state" : 0,
    "signature" : "",
    "createTime" : "2022-11-09 16:37:24",
    "updateTime" : "2022-11-09 16:37:24",
    "validityTime" : null
  }
}

Status Codes

Status Code

Description

200

Authorization response.

400

Invalid request parameter.

401

Username and password are required for the requested page.

403

Authentication failed.

404

Resource not found.

500

Internal server error.

502

Failed to complete the request. The server has received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.