Querying Agency Permission Details

Function

This API is used to query agency permission details. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/agency/{agency_name}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
agency_name	Yes	String	Definition Agency name. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
name	String	Definition Agency name. Range N/A
is_existed	Boolean	Definition Whether an agency exists. Range true: It exists. false: It does not exist.
roles	Array of objects	Definition Policy information bound to the agency. For details, see Table 4.

**Table 4** AgencyRoleResult
Parameter	Type	Description
name	String	Definition Policy name. Range N/A
description	String	Definition Policy description. Range N/A

Example Request

Querying agency permission details

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/9a29cc53af2f499cb48a6d81839264cb/agency/RDSAccessProjectResource

Example Response

{ 
  "name" : "RDSAccessProjectResource", 
  "is_existed" : true, 
  "roles" : [ { 
    "name" : "RDSManager", 
    "description": "policy description 1"
  }, { 
    "name" : "Tenant Administrator", 
    "description": "policy description 2"
  } ] 
}