Help Center/ CodeArts Repo/ API Reference/ APIs/ RepoMember/ Obtains all member records in a warehouse.

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

View PDF

Obtains all member records in a warehouse.

Function

This interface is used to obtain the warehouse member list. You can search for a member by keyword.

URI

GET /v1/repositories/{repository_uuid}/members

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_uuid	Yes	String	Repository UUID, which is returned by the CreateRepository API.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page_index	No	Integer	Indicates the page number.
page_size	No	Integer	Size of Each Page
subject	No	String	Keyword entered for search

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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	RepositoryMemberList object	Result
status	String	Status code in a response

**Table 5** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 6** RepositoryMemberList
Parameter	Type	Description
total	Integer	Total Warehouse Members
users	Array of RepositoryMember objects	Warehouse Member List

**Table 7** RepositoryMember
Parameter	Type	Description
description	String	Warehouse Member Description
domain_id	String	Tenant ID Minimum: 8 Maximum: 32
domain_name	String	Tenant Name
email	String	Email
enabled	String	Indicates whether a member is available.
name	String	User Name
role	Integer	Repository user permission. The options are as follows: 30->common member, 40->administrator
user_id	String	Specifies the user ID. Minimum: 4 Maximum: 32

Example Requests

GET https://{endpoint}/v1/repositories/{repository_uuid}/members

Example Responses

Status code: 200

{
  "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"
}