doc-exports/docs/iam/api-ref/en-us_topic_0079467623.html

Modifying an Agency

Function

This API is used to modify agency information, including the trust_domain_id, description, and trust_domain_name parameters.

URI

• URI format

  PUT /v3.0/OS-AGENCY/agencies/{agency_id}

• URI parameters

  Parameter	Mandatory	Type	Description
  agency_id	Yes	String	ID of an agency.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token with the Security Administrator permission.

• Parameters in the request body

  Parameter	Mandatory	Type	Description
  agency	Yes	Object	Agency information.

• agency

  Parameter	Mandatory	Type	Description
  trust_domain_id	No	String	Account ID of the delegated party. If both trust_domain_id and trust_domain_name are specified, trust_domain_name is preferentially verified. At least one of the four parameters in this table must be specified.
  trust_domain_name	No	String	Account name of the delegated party. If both trust_domain_id and trust_domain_name are specified, trust_domain_name is preferentially verified. At least one of the four parameters in this table must be specified.
  description	No	String	Agency description, which can contain a maximum of 255 characters. At least one of the four parameters in this table must be specified.
  duration	No	String	Validity period (days) of the agency. At least one of these four parameters in this table must be specified. The options are as follows: FOREVER: The agency has unlimited validity. ONEDAY: The agency is valid for one day. Custom: The agency is valid for a specified number of days, for example, 20.

  

  The trust_domain_id and trust_domain_name parameters in a request body must exist or not exist at the same time. If both of them exist, trust_domain_name takes precedence.

• Example request

  curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X PUT -d '{"agency" : {"trust_domain_id" : "35d7706cedbc49a18df0783d00269c20","trust_domain_name" : "exampledomain","description" : "111111"}}' https://sample.domain.com/v3.0/OS-AGENCY/agencies/2809756f748a46e2b92d58d309f67291

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  agency	Yes	JSON object	Delegated object.

• agency

  Parameter	Type	Description
  id	String	ID of an agency.
  name	String	Name of an agency.
  domain_id	String	ID of the current domain.
  trust_domain_id	String	ID of the delegated domain.
  description	String	Description of an agency.
  duration	String	Validity period of an agency. The default value is null, indicating that the agency is permanently valid.
  expire_time	String	Expiration time of an agency.
  create_time	String	Time when an agency is created.
  trust_domain_name	String	Agency name.

• Example response (request successful)

  {
    "agency" : {
       "description" : " testsfdas ",
       "trust_domain_id" : "3ebe1024db46485cb02ef08d3c348477",
       "id" : "c1a06ec7387f430c8122d6f336c66dcf",
       "duration" : null,
       "create_time" : "2017-01-06T05:56:09.738212",
       "expire_time" : null,
       "domain_id" : "0ae9c6993a2e47bb8c4c7a9bb8278d61",
       "name" : "exampleagency"
      }
  }

• Example response (request failed)

  {
    "error": {
      "message": "TrustDomainNotFound",
      "code": 404,
      "title": "Not Found"
    }
  }

Status Codes

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
500	Internal server error.

Parent topic: Agency Management