Authorizing CBH
Function
This API is used to authorize CBH.
URI
GET /v2/{project_id}/cbs/agency/authorization
| 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token. For details, see "Obtaining the Token of an IAM User." |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| authorization | AgencyAuthorizeInfoRsp object | Returned object of the CBH agencies. |
| Parameter | Type | Description |
|---|---|---|
| csms | Boolean | CSMS authorization information. |
| kms | Boolean | KMS authorization information. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Incorrect request parameters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Failed to verify the token. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Permissions required. |
Status code: 404
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.