Obtaining the Member List of a Specified Project
Function
This API is used to obtain the project member list.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/members
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: Regular expression: [A-Za-z0-9]{32} Options: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
Yes |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A Options: Minimum value: 1. Maximum value: 1,000. Default value: 10 |
offset |
Yes |
Integer |
Definition: Pagination index. The offset is an integer multiple of limit. Constraints: Minimum value: 0. Options: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
members |
Array of members objects |
Definition: Project members. |
total |
Integer |
Definition: Total number. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
domain_id |
String |
Definition: Tenant ID. Options: N/A |
domain_name |
String |
Definition: Tenant name. Options: N/A |
user_id |
String |
Definition: User ID. Unique ID of a user in the system. Options: N/A |
user_name |
String |
Definition: Username. Options: N/A |
user_num_id |
Integer |
Definition: Creator numId. User ID of the int type, which is required by some deletion APIs. Options: N/A |
role_id |
Integer |
Definition: Member role ID, which is the key in the enumerated value. Options: –1: project creator 3: project manager 4: developer 5: test manager 6: tester 7: participant 8: viewer 9: O&M manager |
nick_name |
String |
Definition: User nickname. Options: N/A |
role_name |
String |
Definition: Role of a user. The value comes from the enumerated value range. Options: Project creator, project manager, developer, test manager, tester, participant, viewer, and O&M manager. |
user_type |
String |
Definition: User type. Options: User: IAM user Federation: federated account |
forbidden |
Integer |
Definition: Whether the account is disabled. Options: 1 (disabled) and 0 (enabled) |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/members GET {{url}}/v4/projects/ac069b11a3524163ad6348953e2fe93e/members?limit=2&offset=0 { "members": [ { "domain_id": "4e919d73499648e3b0292cd3cbef806a", "domain_name": "devcloud_devcloud_s00404480_01", "user_num_id": 4091, "user_id": "a360371833bf4c558f796fd707b44daf", "user_name": "devcloud_devcloud_s00404480_01", "nick_name": "zhangsanfeng", "role_id": -1, "role_name": "creator", "forbidden": 1, "user_type": null }, { "domain_id": "4e919d73499648e3b0292cd3cbef806a", "domain_name": "devcloud_devcloud_s00404480_01", "user_num_id": 9367, "user_id": "09d25f5d3f80d2881fd7c008ecf1622b", "user_name": "child01", "nick_name": "child01update1", "role_id": 3, "role_name": "aaa", "forbidden": 0, "user_type": null } ], "total": 8 }
Example Responses
Status code: 200
OK
{ "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" : "Project creator", "user_type" : "User", "forbidden" : 0 } ], "total" : 1 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot