Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Obtaining the Member Groups That Can Be Added to a Repository Group
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Member Groups That Can Be Added to a Repository Group

Function

This API is used to obtain the member groups that can be added to a repository group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:group:getMembers

Read

-

-

-

-

URI

GET https://{hostURL}/v4/groups/{group_id}/user-groups/addable-list

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

Integer

Definition

Repository group ID, which is the numeric ID next to Group ID on the repository group homepage.

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list.

Range

String length: 32 characters.

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of UserGroupDto objects

Definition:

Member group list.
Table 5 UserGroupDto

Parameter

Type

Description

id

Integer

Definition:

Unique ID.

Value range:

1~2147483647

name

String

Definition:

Name.

Value range:

1 to 1,000 characters.

user_group_id

String

Definition:

Member group ID.

Value range:

1 to 1,000 characters.

project_id

String

Definition:

Project ID.

Value range:

1 to 1,000 characters.

tenant_id

String

Definition:

Tenant ID.

Value range:

1 to 1,000 characters.

group_type

String

Definition:

Repository group type.

Value range:

1 to 1,000 characters.

member_count

Integer

Definition:

Number of members.

Value range:

1~2147483647

created_at

String

Definition:

Creation time.

Value range:

1 to 1,000 characters.

updated_at

String

Definition:

Update time.

Value range:

1 to 1,000 characters.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/groups/{group_id}/user-groups/addable-list?offset=0&limit=20

Example Responses

Status code: 201

Obtain the member groups that can be added to a repository group.

[ {
  "id" : 291,
  "name" : 3123,
  "user_group_id" : "a89f298bfcfa42a2804920cba6f6e5c2",
  "project_id" : "c65b44ca43b04961860e728cb91acfc6",
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "group_type" : "normal",
  "created_at" : "2025-06-17T01:45:28.904+08:00",
  "updated_at" : "2025-06-17T01:45:28.904+08:00"
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

201

Obtain the member groups that can be added to a repository group.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Group