Help Center/ CodeArts Req/ API Reference/ APIs/ Project members/ Obtaining the Member List of a Specified Project

Updated on 2023-06-12 GMT+08:00

View PDF

Obtaining the Member List of a Specified Project

Function

Obtaining the Project Member List

URI

GET /v4/projects/{project_id}/members

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Specifies the paging index and offset. offset is an integer multiple of limit. limit=10,offset=0,10,20... Minimum: 0 Maximum: 10000 Default: 0
limit	No	Integer	Number of records displayed on each page. A maximum of 100 records can be displayed on each page. Minimum: 1 Maximum: 100 Default: 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
members	Array of members objects	Project Members
total	Integer	Total

**Table 5** members
Parameter	Type	Description
domain_id	String	Tenant ID Minimum: 32 Maximum: 32
domain_name	String	Tenant Name
user_id	String	Specifies the user ID.
user_name	String	User Name
user_num_id	Integer	Creator numId
role_id	Integer	Member Role, -1: project creator, 3 project manager, 4 developers, 5 test manager, 6 test personnel, 7 participant, 8 viewer, 9 O&M manager
nick_name	String	Nickname of the user.
role_name	String	User Roles
user_type	String	User type, User iam user, Federation Account,
forbidden	Integer	Indicates whether the account is disabled. The options are as follows: 1: yes 0: no

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/members

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/members

Example Responses

Status code: 200

{
  "members" : [ {
    "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
    "domain_name" : "demo_user_name",
    "user_id" : "a360371833bf4c558f796fd707b44daf",
    "user_name" : "demo_user_name",
    "user_num_id" : 4097,
    "role_id" : 7,
    "nick_name" : "name",
    "role_name" : "",
    "user_type" : "User",
    "forbidden" : 0
  } ],
  "total" : 1
}