Querying Agency or Trust Agency Details

Function

This API is used to query agency or trust agency details.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:agencies:getV5	Read	agency *	g:ResourceTag/<tag-key>	-	-

URI

GET /v5/agencies/{agency_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
agency_id	Yes	String	Definition Agency or trust agency ID. For details about how to obtain the value, see the API for querying the agency list (ListAgenciesV5) or check the Agencies page on the IAM console. Constraints N/A Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
agency	agency object	Definition: Agency or trust agency. Range: N/A

**Table 3** agency
Parameter	Type	Description
urn	String	Definition: Uniform Resource Name (URN). For details, see Reference. Range: N/A.
trust_policy	String	Definition: JSON format of the policy document of a trust agency's trust policy. Range: N/A
created_at	String	Definition Time when the agency or trust agency was created. The UTC time format is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A
description	String	Definition: Description of an agency or trust agency. Range: N/A
max_session_duration	Integer	Definition: Maximum session duration of an agency or trust agency, in seconds. Range: The value ranges from 3,600 to 43,200.
path	String	Definition Resource path. A resource path is a hierarchical path used to organize and classify resources, which is similar to the directory structure in a file system. Range The value consists of one or more concatenated string segments, with a total length of 0 to 512 characters. Each segment contains one or more letters, digits, periods (.), commas (,), plus signs (+), at signs (@), equal signs (=), underscores (_), or hyphens (-), and ends with a slash (/), for example, foo/bar/.
agency_id	String	Definition Agency or trust agency ID. For details about how to obtain the value, see the API for querying the agency list (ListAgenciesV5) or check the Agencies page on the IAM console. Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
agency_name	String	Definition Name of an agency or trust agency. Range The value contains 1 to 64 characters. Only letters, digits, underscores (_), plus signs (+), equal signs (=), commas (,), periods (.), at signs (@), and hyphens (-) are allowed.
trust_domain_id	String	Definition: ID of the delegated account. Range: N/A
trust_domain_name	String	Definition Name of the delegated account. Range N/A
tags	Array of tags objects	Definition: List of custom tags. Range: N/A

**Table 4** tags
Parameter	Type	Description
tag_key	String	Definition Tag key. Range The value can contain 1 to 128 characters. Letters, digits, spaces, and the following special characters are allowed: _.:=+-@. The key cannot start with a space or _sys_ or end with a space.
tag_value	String	Definition Tag value. Range The value can be an empty string or contain 0 to 255 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition: Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Example Requests

Querying agency details

GET https://{endpoint}/v5/agencies/{agency_id}

Example Responses

Status code: 200

{
  "agency" : {
    "urn" : "iam::123456789012:agency:example-agency",
    "trust_policy" : "{\"Version\":\"5.0\",\"Statement\":[{\"Action\":[\"sts:agencies:assume\",\"sts::tagSession\",\"sts::setSourceIdentity\"],\"Effect\":\"Allow\",\"Principal\":{\"IAM\":[\"xxx\"]}}]}",
    "created_at" : "2023-09-21T01:17:19.590Z",
    "description" : "description",
    "max_session_duration" : 3600,
    "path" : "",
    "agency_id" : "example-agency-id",
    "agency_name" : "example-agency-name",
    "trust_domain_id" : null,
    "trust_domain_name" : null,
    "tags" : [ {
      "tag_key" : "key",
      "tag_value" : "value"
    } ]
  }
}