Obtaining All Member Records in a Repository
Description
This API is used to obtain the repository member list. You can search for a member by keyword.
URI
GET /v1/repositories/{repository_uuid}/members
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
repository_uuid |
Yes |
String |
Repository UUID returned by the CreateRepository API. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
page_index |
No |
Integer |
Page number |
|
page_size |
No |
Integer |
Size of each page |
|
subject |
No |
String |
Search keyword |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
Error object |
Response error |
|
result |
RepositoryMemberList object |
Response result |
|
status |
String |
Response status |
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number of repository members |
|
users |
Array of RepositoryMember objects |
Repository member list |
|
Parameter |
Type |
Description |
|---|---|---|
|
description |
String |
Repository member description |
|
domain_id |
String |
Tenant ID Minimum length: 8 Maximum length: 32 |
|
domain_name |
String |
Tenant name |
|
|
String |
Email address |
|
enabled |
String |
Whether a member is available |
|
name |
String |
Username |
|
role |
Integer |
Repository user permission: 30: Common member. 40: Administrator. |
|
user_id |
String |
User ID Minimum length: 4 Maximum length: 32 |
Request Examples
GET https://{endpoint}/v1/repositories/{repository_uuid}/members
Response Examples
Status code: 200
Request succeeded
{
"result" : {
"total" : 2,
"users" : [ {
"user_id" : "5836",
"name" : "repo",
"domain_name" : "repo",
"description" : null,
"enabled" : null,
"role" : 40,
"domain_id" : "159b65b41ead484d8ddff250a4731781",
"email" : null
}, {
"user_id" : "6057",
"name" : "repo",
"domain_name" : "repo",
"description" : null,
"enabled" : null,
"role" : 30,
"domain_id" : "159b65b41ead484d8ddff250a4731781",
"email" : null
} ]
},
"status" : "success"
}
Status Codes
|
Status Codes |
Description |
|---|---|
|
200 |
Request succeeded |
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