Help Center/ MapReduce Service/ API Reference/ API V2/ IAM Synchronization/ Obtaining Synchronized IAM Users and User Groups
Updated on 2024-12-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Synchronized IAM Users and User Groups

Function

This API is used to obtain synchronized IAM users and user groups.

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

GET /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

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

user_names

Array of strings

Explanation

Synchronized users.

Constraints

N/A

Value range

N/A

Default value

N/A

group_names

Array of strings

Explanation

Synchronized user groups.

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

None

Example Response

Status code: 200

Synchronized users and user groups

{
  "user_names" : [ "user1", "user2" ],
  "group_names" : [ "group1" ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: IAM Synchronization