• Identity and Access Management

iam
  1. Help Center
  2. Identity and Access Management
  3. API Reference
  4. Agency Management
  5. Creating an Agency

Creating an Agency

Function Description

This interface is used to create an agency.

URI

URI format

POST /v3.0/OS-AGENCY/agencies

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    application/json;charset=utf8

    X-Auth-Token

    Yes

    String

    Authenticated token with the Security Administrator permission.

  • Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    name

    Yes

    String

    Name of an agency. The length is less than or equal to 64 characters.

    domain_id

    Yes

    String

    ID of the current domain.

    trust_domain_id

    At least one

    String

    ID of the delegated domain.

    trust_domain_name

    String

    Name of the delegated domain.

    description

    No

    String

    Description of an agency. The length is less than or equal to 255 characters.

    NOTE:

    At least one of trust_domain_id and trust_domain_name must exist in the request body. If both of them exist, trust_domain_name prevails.

  • Sample request
    curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X POST -d'{"agency" : {"name" : "exampleagency","domain_id" : "0ae9c6993a2e47bb8c4c7a9bb8278d61","trust_domain_id" : "35d7706cedbc49a18df0783d00269c20","trust_domain_name" : "exampledomain","description" : "testsfdas"}}' https://sample.domain.com/v3.0/OS-AGENCY/agencies

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    agency

    Yes

    JSONObject

    Delegated object.

  • Description for the agency format

    Parameter

    Mandatory

    Type

    Description

    id

    Yes

    String

    ID of an agency.

    name

    Yes

    String

    Name of an agency.

    domain_id

    Yes

    String

    ID of the current domain.

    trust_domain_id

    Yes

    String

    ID of the delegated domain.

    description

    Yes

    String

    Description of an agency.

    duration

    Yes

    String

    Validity period of an agency. The default value is null, indicating that the agency is permanently valid.

    expire_time

    Yes

    String

    Expiration time of an agency.

    create_time

    Yes

    String

    Time when an agency is created.

  • Sample response (request successful)
    {
      "agency" : {
         "description" : "testsfdas",
         "trust_domain_id" : "35d7706cedbc49a18df0783d00269c20",
         "id" : "c1a06ec7387f430c8122d6f336c66dcf",
         "duration" : null,
         "create_time" : "2017-01-06T05:56:09.738212",
         "expire_time" : null,
         "domain_id" : "0ae9c6993a2e47bb8c4c7a9bb8278d61",
         "name" : "exampleagency"
        }
    }
  • Sample response (request failed)
    {
        "error": {
            "message": "'name' is a required property",
            "code": 400,
            "title": "Bad Request"
        }
    }

Status Codes

Status Code

Description

201

The request is successful.

400

The server failed to process the request.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

409

The agency already exists.

500

Failed to complete the request because of an internal service error.