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

Updated on 2022-12-14 GMT+08:00

View PDF

Function

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

URI

URI format
PUT /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

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

**Table 3** agency_mappings parameters
Parameter	Mandatory	Type	Description
agency	Yes	String	The name of the IAM agency bound to the mapping.
identifier_type	Yes	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	Yes	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	Yes	String	The 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.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
result	String	The operation result of the request for updating a mapping. Possible values: succeeded: The operation is successful. failed: The operation failed.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code.
error_msg	String	The error description.

Example

Example request

Example request for updating the mapping between a user or user group and an IAM agency

PUT https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/agency-mapping

{
  "agency_mappings" : [ {
    "agency" : "agency01",
    "identifier_type" : "User",
    "identifiers" : [ "test" ],
    "agency_id" : "xxxx"
  } ]
}