Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Agency Authorization/ Creating or Canceling an Agency Authorization for CBH.
Updated on 2025-12-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating or Canceling an Agency Authorization for CBH.

Function

This API is used to create or cancel an agency authorization for CBH.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/cbs/agency/authorization

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain the value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

For details, see Obtaining a User Token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

authorization

Yes

AgencyAuthorizeInfo object

Request object for setting CBH agencies for Cloud Secret Management Service (CSMS) and Key Management Service (KMS). Either KMS or CSMS must be specified.
Table 4 AgencyAuthorizeInfo

Parameter

Mandatory

Type

Description

csms

No

Boolean

Credential management permission information.

kms

No

Boolean

Key management permission information.

Response Parameters

Status code: 200

Authorize Csms And Kms Success

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Not CBH instances found.

Example Requests

{
  "authorization" : {
    "csms" : true
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

Authorize Csms And Kms Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Agency Authorization