Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Agency Management/ Viewing Agency Information
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Viewing Agency Information

Function

check service linked agency

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/agency

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can call the IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

X-Language

No

String

Language.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

create_agency

Boolean

Whether a cloud service agency has been created for the current account.

role_descriptions

Array of Role objects

Role list.
Table 4 Role

Parameter

Type

Description

id

String

Role ID.

display_name

String

Role name.

role_description

String

Role description.

description

String

Description.

scope

String

Role scope.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

Status code: 403

Insufficient permissions.

{
  "error_code" : "csb.00180004",
  "error_msg" : "Permission iam:agencies:getAgency is required to query agency details."
}

Status code: 500

Internal system error.

{
  "error_code" : "csb.00180001",
  "error_msg" : "System busy. Try again later."
}

Status Codes

Status Code

Description

200

Required permissions.

403

Insufficient permissions.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic: Agency Management