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

Authorizing CBH

Function

This API is used to authorize CBH.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

authorization

AgencyAuthorizeInfoRsp object

Returned object of the CBH agencies.
Table 4 AgencyAuthorizeInfoRsp

Parameter

Type

Description

csms

Boolean

CSMS authorization information.

kms

Boolean

KMS authorization information.

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

None

Example Responses

Status code: 200

CBH authorization details queried

{
  "authorization" : {
    "csms" : true,
    "kms" : true
  }
}

Status Codes

Status Code

Description

200

CBH authorization details queried

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Agency Authorization