Help Center/ DataArts Insight/ API Reference/ Pass Management/ Listing the Users Who Have Been Assigned Passes (Excluding Inactive Users)
Updated on 2025-02-25 GMT+08:00

Listing the Users Who Have Been Assigned Passes (Excluding Inactive Users)

Function

This API is used to list the users who have been assigned passes (excluding inactive users).

URI

GET /v1/{project_id}/quota-users

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

No

String

System-defined roles. The options include:

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

type

No

String

Role type. The value can be IAM or SELF-BUILT.

sort_key

No

String

Sorting field. The options include effectiveTime and accountName.

sort_dir

No

String

Sorting mode. The options are desc and asc.

offset

No

Integer

Number of pages. The default value is 0.

limit

No

Integer

Number of data records on each page. The default value is 10.

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 parameters

Parameter

Type

Description

count

Integer

Total data volume.

page_data

Array of Table 5 objects

Data.

Table 5 page_data

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.

Enumerated values:

  • 0
  • 1
  • 2

effective_time

Long

Effective timestamp.

Example Request

GET https://{endpoint}/v1/{project_id}/quota-users?sort_key=accountName&sort_dir=asc&limit=10&offset=0&account_name=&sys_role=1

Example Response

None

Status Codes

Status Code

Description

200

Passes are successfully listed.

Error Codes

See Error Codes.