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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition You can call the API used to query project list to query the project list to obtain the unique 32-character UUID of the project. Range A string that can contain 32 characters. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| scope | No | String | Definition Create resource types. Constraints Default value: repository Enumeration values: |
| 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| [items] | Array of ManageableGroupDto objects | Repository groups that the current user has management permissions for. |
| Parameter | Type | Description |
|---|---|---|
| full_name | String | Definition Repository group full name. |
| id | Integer | Definition Repository group ID. Value range: 1~2147483647 |
| name | String | Definition Repository group name. Range A maximum of 256 characters. |
| full_path | String | Definition Full path. Range A maximum of 1,000 characters. |
| path | String | Definition Path. Range A maximum of 1,000 characters. |
| visibility | String | Definition Visibility. Range private or public. Enumeration values: |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 404
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot