Obtaining the List of Members That Can Be Added to a Repository Group
Function
This API is used to obtain the list of members 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.
URI
GET https://{hostURL}/v4/groups/{group_id}/members/addable-list
| 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. Value range: 1~2147483647 |
| 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 |
| 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. 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| [items] | Array of GroupBatchAddMemberDto objects | Definition: Member list. |
| Parameter | Type | Description |
|---|---|---|
| iam_id | String | Definition IAM ID of the user. Range 1–1,000 characters. |
| user_id | String | Definition User ID. Range 1–1,000 characters. |
| name | String | Definition Username. Range 1–1,000 characters. |
| nick_name | String | Definition User alias. Range 1–1,000 characters. |
| domain_name | String | Definition Tenant name. Range 1–1,000 characters. |
| domain_id | String | Definition Tenant ID. Range 1–1,000 characters. |
| repo_role_id | String | Definition Role ID. Range 1–1,000 characters. |
| req_role_id | String | Definition Project role ID. Range 1–1,000 characters. |
| repo_role_name | String | Definition Role name. Range 1–1,000 characters. |
| req_role_name | String | Definition Project role name. Range 1–1,000 characters. |
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. |
Example Requests
GET https://{endpoint}/v4/groups/{group_id}/members/addable-list Example Responses
Status code: 200
Obtain the list of members that can be added to a repository group.
[ {
"iam_id" : "7be75ff77809436bb8acb031a7640098",
"user_id" : null,
"name" : "7be75ff77809436bb8acb031a7640098",
"nick_name" : null,
"domain_name" : "devcloud_codehub_l00314597_01",
"domain_id" : "159b65b41ead484d8ddff250a4731781",
"repo_role_id" : "c58e56f8e8684d2e83f48b8674485de7",
"req_role_id" : "c58e56f8e8684d2e83f48b8674485de7",
"repo_role_name" : "Committer",
"req_role_name" : "Committer"
} ] 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 members that can be added to a repository group. |
| 401 | Unauthorized |
| 403 | Bad Request |
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.
