Help Center/ MapReduce Service/ API Reference/ API V2/ Agency Management/ Querying the Mapping Between a User (Group) and an IAM Agency

Updated on 2024-09-30 GMT+08:00

View PDF

Querying the Mapping Between a User (Group) and an IAM Agency

Function

This API is used to obtain details about the mapping between a user or user group and an IAM agency.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

URI format
GET /v2/{project_id}/clusters/{cluster_id}/agency-mapping

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation The cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response parameter
Parameter	Type	Description
agency_mappings	Array of AgencyMapping objects	Explanation The mapping between users or user groups and agencies. For details, see Table 3. Constraints N/A

**Table 3** agency_mappings parameters
Parameter	Type	Description
agency	String	Explanation The name of the IAM agency bound to the mapping. Constraints N/A Value range N/A Default value N/A
identifier_type	String	Explanation The agency type. Available values are User and Group. Constraints N/A Value range User: indicates that the mapping is for users. Enter the user name list in identifiers. Group: indicates that the mapping is for user groups. Enter the user group name list in identifiers. Default value N/A
identifiers	Array of String	Explanation List of users or user groups mapped to the IAM agency. Log in to the IAM management console and choose Users or User Groups in the navigation pane to obtain the user or user group name list. Constraints N/A
agency_id	String	Explanation Unique ID of the agency bound to the mapping. Log in to the IAM management console and choose Agencies in the left navigation pane. On the Agencies page that is displayed, move your cursor over the agency name to obtain the agency ID. Constraints N/A Value range N/A Default value N/A

Status code: 400

**Table 4** Response parameters
Parameter	Type	Description
error_code	String	Explanation Error code. Value range N/A
error_msg	String	Explanation Error message Value range N/A

Example Request

None

Example Response

Status code: 200

Querying the mapping between a user or user group and an IAM agency is successful.

{
  "agency_mappings" : [ {
    "agency" : "agency01",
    "identifier_type" : "User",
    "identifiers" : [ "user01" ],
    "agency_id" : "092adc623c00d2ea4fdac01d4b637f0b"
  }, {
    "agency" : "agency02",
    "identifier_type" : "User",
    "identifiers" : [ "user02" ],
    "agency_id" : "065239307e00d3ae4f80c01d4bdafdfd"
  }, {
    "agency" : "groupAgency",
    "identifier_type" : "Group",
    "identifiers" : [ "group01", "group02", "group03" ],
    "agency_id" : "08467a446200d5ac4ff9c01d56670c3b"
  } ]
}