Creating a Service Agency

Function

Create a service agency for CSMS and FunctionGraph.

Calling Method

For details, see Calling APIs.

URI

POST /v1/csms/agencies

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
secret_type	Yes	String	Secret type

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
agencies	Array of Agency objects	Agency details list

**Table 3** Agency
Parameter	Type	Description
agency_name	String	Agency name
agency_id	String	Agency ID
error_msg	String	Error message. Returned error message when the agency fails to be created.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 502

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 504

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Example Requests

Create an agency for RDS-FG secrets.

{
  "secret_type" : "RDS-FG"
}

Example Responses

Status code: 200

Request succeeded.

{
  "agencies" : [ {
    "agency_name" : "xxxx1",
    "agency_id" : "xxxxxxx"
  }, {
    "agency_name" : "xxxxx2",
    "error_msg" : "xxxxxxxx"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	Username and password are required for the requested page.
403	Authentication failed.
404	The resource does not exist.
500	Internal service error.
502	Request failed. The server has received an invalid response.
504	Gateway timed out.