Obtaining the Member Group List of a Project

This API is used to obtain the member group list of a project (used in protected branch and protected tag settings).

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

GET https://{hostURL}/v4/projects/{project_id}/protected-refs/user-groups

**Table 1** Path 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. Value range: 32 characters

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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
search	No	String	Definition Query keyword for fuzzy match, such as username, user alias, and tenant name.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Total	String	Definition: Total number of member groups

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of ProtectedRefsUserGroupBasicDto objects	Member group list

**Table 6** ProtectedRefsUserGroupBasicDto
Parameter	Type	Description
id	Integer	Definition: Member group ID Value range: N/A Value range: 0~2147483647
name	String	Definition: Member group name Value range: N/A

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

GET https://{endpoint}/v4/projects/f11fc2c7ff0e429ab934a97faa6e9efa/protected-refs/user-groups

Status code: 200

[ {
  "id" : 220,
  "name" : "hxbcr1024_1"
} ]

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."
}

Parent topic: Member

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.