Help Center/ CodeArts Repo/ API Reference/ APIs/ RepoMember/ Obtaining All Member Records in a Repository
Updated on 2025-05-15 GMT+08:00
View PDF

Obtaining All Member Records in a Repository

Function

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_uuid

Yes

String

Explanation:

Repository UUID returned by the CreateRepository API.

Constraints:

Mandatory

Range:

32 digits and letters.

Default value:

None
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page_index

No

Integer

Explanation:

Page number.

Constraints:

None

Range:

Digits

Default value:

None

page_size

No

Integer

Explanation:

Number of records displayed on each page.

Constraints:

None

Range:

Digits

Default value:

None

subject

No

String

Explanation:

Keyword for fuzzy match, such as username, alias, and tenant name.

Constraints:

None

Range:

128 characters.

Default value:

None

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

result

RepositoryMemberList object

Response result.

status

String

Response status.
Table 5 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.
Table 6 RepositoryMemberList

Parameter

Type

Description

total

Integer

Total number of repository members.

users

Array of RepositoryMember objects

Repository member list.
Table 7 RepositoryMember

Parameter

Type

Description

description

String

Repository member description.

domain_id

String

Tenant ID.

Minimum length: 8

Maximum length: 32

domain_name

String

Tenant name.

email

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

Example Requests

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

Example Responses

Status code: 200

OK

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

Description

200

OK

Error Codes

See Error Codes.

Parent topic: RepoMember