Help Center> MapReduce Service> API Reference> API V2> Agency Management> Querying the Mapping Between a User (Group) and an IAM Agency
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.

URI

  • URI format

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

  • Parameters
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

    cluster_id

    Yes

    Cluster ID.

Request

Request parameters

None

Response message.

Table 2 Response parameters

Parameter

Type

Description

agency_mappings

Array

For details about the mapping between users or user groups and agencies, see Table 3.
Table 3 agency_mappings parameter description

Parameter

Type

Description

agency

String

Specifies the name of the IAM agency bound to the mapping.

identifier_type

String

Agency type, which can be User or Group.

  • 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

Indicates the list of users or user groups mapped to the IAM agency.

agency_id

String

Unique ID of the agency bound to the mapping.

Examples

  • Request example

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

Status Code

Table 4 describes the status code.

Table 4 Status Code

Status Code

Description

200

The operation is successful.
Parent topic: Agency Management