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

Updated on 2022-11-18 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 through automatic authentication in API Explorer. 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	The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
cluster_id	Yes	String	The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Request Parameters

Request parameters

None

Response Parameters

Status code: 200

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

**Table 3** agency_mappings parameters
Parameter	Type	Description
agency	String	The name of the IAM agency bound to the mapping.
identifier_type	String	The agency type. Possible values: User: indicates that the mapping is for users. The user name list is displayed in identifiers. Group: indicates that the mapping is for user groups. The user group name list is displayed in identifiers.
identifiers	Array of String	The 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 left navigation pane to obtain the user or user group name list.
agency_id	String	The 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.

Status code: 400

**Table 4** Response parameters
Parameter	Type	Description
error_code	String	The error code.
error_msg	String	The error message.

Example

Example request
None

Example response

{
	"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"
		}
	]
}