Updated on 2025-02-14 GMT+08:00

Creating an Agency

Function

This API is used to create an agency.

URI

POST /v1/{project_id}/cae/agencies

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Maximum characters: 16,384

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

Yes

String

API type. Fixed value: Agency.

Enumerated value:

  • Agency

metadata

Yes

metadata object

Request data.

Table 4 metadata

Parameter

Mandatory

Type

Description

name

Yes

String

Agency name. Fixed value: cae_trust.

Enumerated 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

None

Example Request

Create agency cae_trust.

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

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

Example Response

None

Status Code

Status Code

Description

204

The request is successful.

Error Code

For details, see Error Codes.