Help Center/ MapReduce Service/ API Reference (Kuala Lumpur Region)/ API V2/ Agency Management/ Updating the Mapping Between a User (Group) and an IAM Agency
Updated on 2022-08-12 GMT+08:00
View PDF

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

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

  • 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

Table 2 Parameter description

Parameter

Mandatory

Type

Description

agency_mappings

Yes

Array

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

Parameter

Mandatory

Type

Description

agency

Yes

String

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

identifier_type

Yes

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

Yes

Array of String

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

agency_id

Yes

String

Unique identifier of the agency bound to the mapping. For details about how to obtain the agency_id of the agency to be updated, see Querying the Mapping Between a User (Group) and an IAM Agency.

Response message.

Table 4 Response parameters

Parameter

Type

Description

result

String

Operation result.

  • succeeded: The operation is successful.
  • failed: The operation failed.

Examples

  • Request example

    None

  • Example response

    None

Status Code

Table 5 describes the status code of this API.

Table 5 Status Code

Status Code

Description

200

The operation is successful.
Parent topic: Agency Management