Updated on 2025-12-19 GMT+08:00

Creating an Agency

Function

This API is used to create an agency.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/cae/agencies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

kind

Yes

String

API type. Fixed value: Agency.

metadata

Yes

metadata object

Request data.

Table 4 metadata

Parameter

Mandatory

Type

Description

name

Yes

String

Agency name. Fixed value: cae_trust.

roles

No

Array of strings

List of existing agency permissions.

missing_roles

No

Array of strings

List of missing agency permissions.

Response Parameters

Status code: 204

Request succeeded.

None

Example Requests

Create agency cae_trust.

POST https://{endpoint}/v1/{project_id}/cae/agencies

{
  "api_version" : "v1",
  "kind" : "Agency",
  "metadata" : {
    "name" : "cae_trust"
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Request succeeded.

Error Codes

See Error Codes.