Help Center/ MapReduce Service/ API Reference (Ankara Region)/ API V2/ IAM Synchronization/ Synchronizing an IAM User and User Group
Updated on 2024-11-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Synchronizing an IAM User and User Group

Function

This API is used to synchronize IAM users and user groups to Manager. If a user is specified, the IAM user group the user belongs is also synchronized.

URI

POST /v2/{project_id}/clusters/{cluster_id}/iam-sync-user

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

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

is_all_sync

No

Boolean

Explanation

Whether to perform full synchronization.

Constraints

N/A

Value range

  • true: full synchronization
  • false: synchronization of specified users and user groups

Default value

false

group_names

No

Array of strings

Explanation

IAM user groups to be synchronized

Constraints

N/A

user_names

No

Array of strings

Explanation

IAM user to be synchronized

Constraints

N/A

Response Parameters

Status code: 202

Table 3 Response body parameter

Parameter

Type

Description

state

String

Explanation

Request result

Value range

N/A

Example Request

Synchronize group1 and user1 to the Manager. The IAM user group associated with user1 is automatically synchronized to Manager.

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/iam-sync-user

{
  "is_all_sync" : false,
  "group_names" : [ "groups1" ],
  "user_names" : [ "user1", "user2" ]
}

Example Response

Status code: 202

Result the synchronization request.

{
  "state" : "synchronizing"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: IAM Synchronization