Help Center/ DataArts Insight/ API Reference/ Pass Management/ Listing Allocated, Inactive, and All IAM Users
Updated on 2025-02-25 GMT+08:00

Listing Allocated, Inactive, and All IAM Users

Function

This API is used to list allocated, inactive, and all IAM users.

URI

GET /v1/{project_id}/quota-users/all

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

account_name

No

String

Username (fuzzy search).

sys_role_list

No

Array

System-defined roles. The options include:

  • 0: inactive user.
  • 1: general user.
  • 2: read-only user.

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

[Array element]

Array of Table 5 objects

-

Table 5 UserQuotaVo

Parameter

Type

Description

user_id

String

User ID.

account_name

String

Username.

user_type

String

User type. The options are IAM, SELF-BUILT, and DEFAULT.

sys_role

Integer

User role. The options include:

  • 0: inactive user.
  • 1: general user.
  • 2: read-only user.

effective_time

Long

Effective timestamp.

Example Request

GET https://{endpoint}/v1/{project_id}/quota-users/all?account_name=&sys_role_list=

Example Response

None

Status Codes

Status Code

Description

200

All users are successfully listed.

Error Codes

See Error Codes.