Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Agency Authorization/ Creating or Canceling an Agency Authorization for CBH.
Updated on 2024-11-12 GMT+08:00

Creating or Canceling an Agency Authorization for CBH.

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

For details about how to obtain the project ID, see "Obtaining a Project ID".

Request Parameters

Table 2 Request header 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.

For details, see "Obtaining the Token of an IAM User."

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

authorization

Yes

AgencyAuthorizeInfo object

List of CBH permissions managed in Cloud Secret Management Service (CSMS) and Key Management Service (KMS).

Table 4 AgencyAuthorizeInfo

Parameter

Mandatory

Type

Description

csms

Yes

Boolean

Credential management permission information.

kms

Yes

Boolean

Key management permission information.

Response Parameters

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,
    "kms" : 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.