Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Obtain the List of Repository Group Permission Resource Points.
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtain the List of Repository Group Permission Resource Points.

Function

This API is used to obtain the list of repository group permission resource points.

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/groups/permissions/resources

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

scope

No

String

Definition

Type of the resource created.

Constraints

  • group: repository group.

  • project: project.

  • all: repository groups and projects

Default value:

all

Enumeration values:

  • group

  • project

  • all

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

use_project_permission

Boolean

Definition

Whether to use the project permission.

resources

Array of PermissionResourcesDto objects

Definition

Resource list.
Table 4 PermissionResourcesDto

Parameter

Type

Description

id

Integer

Definition

Resource ID.

Value range:

1~2147483647

name

String

Definition

Resource name.

Range

1–1,000 characters.

name_cn

String

Definition

Resource name in Chinese.

Range

1–1,000 characters.

resource_name_display

String

Definition

Name of the disabled resource.

Range

1–1,000 characters.

resource_name_cn_display

String

Definition

Name of the disabled resource in Chinese.

Range

1–1,000 characters.

path

String

Definition

Permission path.

Range

1–1,000 characters.

scope

String

Definition

Resource type.

Range

1–1,000 characters.

created_at

String

Definition

Creation time.

Range

1–1,000 characters.

updated_at

String

Definition

Update time.

Range

1–1,000 characters.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 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/permissions/resources

Example Responses

Status code: 200

Obtain the list of repository group permission resource points.

{
  "resources" : [ {
    "id" : 1,
    "name" : "repository",
    "name_cn" : "Repository",
    "path" : "/codeartsrepo/repo/repository/*",
    "created_at" : "2023-09-12T22:49:09.000+08:00",
    "updated_at" : "2023-09-12T22:49:09.000+08:00"
  }, {
    "id" : 2,
    "name" : "code",
    "name_cn" : "Code",
    "path" : "/codeartsrepo/repo/code/*",
    "created_at" : "2023-09-12T22:49:09.000+08:00",
    "updated_at" : "2023-09-12T22:49:09.000+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

200

Obtain the list of repository group permission resource points.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Group