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.

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and support sample SDK code debugging.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
cluster_id	Yes	String	Cluster ID

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
is_all_sync	No	Boolean	Full synchronization. Value true indicates full synchronization, and false indicates synchronization of specified users and user groups. The default value is false.
group_names	No	Array of strings	IAM user groups to be synchronized
user_names	No	Array of strings	IAM users to be synchronized

Response Parameters

Status code: 202

**Table 3** Response body parameter
Parameter	Type	Description
state	String	Request result

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