Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Member/ Obtaining the Member List in a Project
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Member List in a Project

Function

This API is used to obtain the member list in a project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:group:getMembers

Read

-

-

-

-

URI

GET https://{hostURL}/v4/projects/{project_id}/members

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

You can obtain the unique project identifier, 32-character project UUID, by calling the API used to query the project list.

Range

String length: 32 characters.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

query

No

String

Definition

Member search string.

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of GrantedUsersDto objects

Definition:

Member list.
Table 5 GrantedUsersDto

Parameter

Type

Description

id

Integer

Definition

User ID.

Value range:

1~2147483647

name

String

Definition

Username.

Range

1–1,000 characters.

name_cn

String

Definition

Username in Chinese.

Range

1–1,000 characters.

username

String

Definition

IAM ID of the user.

Range

1–1,000 characters.

nick_name

String

Definition

User alias.

Range

1–1,000 characters.

tenant_name

String

Definition

Tenant name.

Range

1–1,000 characters.

email

String

Definition

Email address of the user.

Range

1–1,000 characters.

iam_id

String

Definition

IAM ID of the user.

Range

1–1,000 characters.

service_license_status

Integer

Definition

License status.

Value range:

1~2147483647

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/projects/{project_id}/members?offset=0&limit=20

Example Responses

Status code: 200

Obtain the member list in a project.

[ {
  "id" : 7574,
  "name" : "devcloud_codehub_l00314597_01",
  "name_cn" : null,
  "username" : "a618e34bd5704be3ae3395dfede06041",
  "nick_name" : "Tenant administrator",
  "tenant_name" : "devcloud_codehub_l00314597_01",
  "email" : "a618e34bd5704be3ae3395dfede06041@example.com",
  "iam_id" : "a618e34bd5704be3ae3395dfede06041",
  "service_license_status" : 1
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

Obtain the member list in a project.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Member