Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Obtaining the List of Repository Groups That the Current User Has Management Permissions for in a Project
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the List of Repository Groups That the Current User Has Management Permissions for in a Project

Function

This API is used to obtain the list of repository groups that the current user has management permissions for in a project.

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:getGroup

Read

-

-

-

-

URI

GET https://{hostURL}/v4/{project_id}/manageable-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Range

String length: 32 characters.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

scope

No

String

Definition

Create resource types.

Constraints

  • group: indicates a repository group.

  • repository: indicates a repository.

Default value:

repository

Enumeration values:

  • group

  • repository

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: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of ManageableGroupDto objects

Repository groups that the current user has management permissions for.
Table 5 ManageableGroupDto

Parameter

Type

Description

full_name

String

Repository group full name

id

Integer

Repository group ID

Value range:

1~2147483647

name

String

Repository group name

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.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

/v4/{project_id}/manageable-groups?scope=group&offset=0&limit=20

Example Responses

Status code: 200

Repository groups that the current user has management permissions for.

[ {
  "full_name" : " TG2 / dmz1",
  "id" : 2111688350,
  "name" : "dmz1"
} ]

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 code: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Group Not Found. Group Not Found"
}

Status Codes

Status Code

Description

200

Repository groups that the current user has management permissions for.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Group