debian-mirror-gitlab/doc/api/members.md

399 lines
13 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Group and project members API
2016-09-13 17:45:13 +05:30
2020-07-28 23:09:34 +05:30
## Valid access levels
2016-09-13 17:45:13 +05:30
The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized:
2020-06-23 00:09:42 +05:30
- No access (`0`)
- Guest (`10`)
- Reporter (`20`)
- Developer (`30`)
- Maintainer (`40`)
- Owner (`50`) - Only valid to set for groups
CAUTION: **Caution:**
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
projects in personal namespaces will not show owner (`50`) permission
for owner.
2016-09-13 17:45:13 +05:30
2020-10-24 23:57:45 +05:30
## Limitations
The `group_saml_identity` attribute is only visible to a group owner for [SSO enabled groups](../user/group/saml_sso/index.md).
The `email` attribute is only visible to a group owner who manages the user through [Group Managed Accounts](../user/group/saml_sso/group_managed_accounts.md).
2016-09-13 17:45:13 +05:30
## List all members of a group or project
Gets a list of group or project members viewable by the authenticated user.
2018-12-05 23:21:45 +05:30
Returns only direct members and not inherited members through ancestors groups.
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
This function takes pagination parameters `page` and `per_page` to restrict the list of users.
```plaintext
2016-09-13 17:45:13 +05:30
GET /groups/:id/members
GET /projects/:id/members
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `query` | string | no | A query string to search for members |
2019-12-21 20:55:43 +05:30
| `user_ids` | array of integers | no | Filter the results on the given user IDs |
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
[
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
2018-11-18 11:00:15 +05:30
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 30,
"group_saml_identity": null
2016-09-13 17:45:13 +05:30
},
{
"id": 2,
"username": "john_doe",
"name": "John Doe",
"state": "active",
2018-11-18 11:00:15 +05:30
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 30,
2020-06-23 00:09:42 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"group_saml_identity": {
"extern_uid":"ABC-1234567890",
"provider": "group_saml",
"saml_provider_id": 10
}
2018-11-18 11:00:15 +05:30
}
]
```
## List all members of a group or project including inherited members
2020-11-24 15:15:51 +05:30
Gets a list of group or project members viewable by the authenticated user, including inherited members and permissions through ancestor groups.
CAUTION: **Caution:**
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/249523), the users effective `access_level` may actually be higher than returned value when listing group members.
2018-11-18 11:00:15 +05:30
2020-04-08 14:13:33 +05:30
This function takes pagination parameters `page` and `per_page` to restrict the list of users.
```plaintext
2018-11-18 11:00:15 +05:30
GET /groups/:id/members/all
GET /projects/:id/members/all
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `query` | string | no | A query string to search for members |
2019-12-21 20:55:43 +05:30
| `user_ids` | array of integers | no | Filter the results on the given user IDs |
2018-11-18 11:00:15 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/all"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/all"
2018-11-18 11:00:15 +05:30
```
Example response:
```json
[
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 30,
"group_saml_identity": null
2018-11-18 11:00:15 +05:30
},
{
"id": 2,
"username": "john_doe",
"name": "John Doe",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
"access_level": 30
2020-06-23 00:09:42 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"group_saml_identity": {
"extern_uid":"ABC-1234567890",
"provider": "group_saml",
"saml_provider_id": 10
}
2018-11-18 11:00:15 +05:30
},
{
"id": 3,
"username": "foo_bar",
"name": "Foo bar",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-11-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 30,
"group_saml_identity": null
2016-09-13 17:45:13 +05:30
}
]
```
## Get a member of a group or project
2019-12-21 20:55:43 +05:30
Gets a member of a group or project. Returns only direct members and not inherited members through ancestor groups.
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
GET /groups/:id/members/:user_id
GET /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `user_id` | integer | yes | The user ID of the member |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/:user_id"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
2018-11-18 11:00:15 +05:30
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
2016-09-13 17:45:13 +05:30
"access_level": 30,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"expires_at": null,
"group_saml_identity": null
2016-09-13 17:45:13 +05:30
}
```
2019-12-21 20:55:43 +05:30
## Get a member of a group or project, including inherited members
2020-03-13 15:44:24 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17744) in GitLab 12.4.
2019-12-21 20:55:43 +05:30
Gets a member of a group or project, including members inherited through ancestor groups. See the corresponding [endpoint to list all inherited members](#list-all-members-of-a-group-or-project-including-inherited-members) for details.
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-21 20:55:43 +05:30
GET /groups/:id/members/all/:user_id
GET /projects/:id/members/all/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/all/:user_id"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/all/:user_id"
2019-12-21 20:55:43 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"access_level": 30,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"expires_at": null,
"group_saml_identity": null
2019-12-21 20:55:43 +05:30
}
```
2016-09-13 17:45:13 +05:30
## Add a member to a group or project
Adds a member to a group or project.
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
POST /groups/:id/members
POST /projects/:id/members
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `user_id` | integer | yes | The user ID of the new member |
| `access_level` | integer | yes | A valid access level |
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "user_id=1&access_level=30" "https://gitlab.example.com/api/v4/groups/:id/members"
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "user_id=1&access_level=30" "https://gitlab.example.com/api/v4/projects/:id/members"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
2018-11-18 11:00:15 +05:30
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 30,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"group_saml_identity": null
2016-09-13 17:45:13 +05:30
}
```
## Edit a member of a group or project
Updates a member of a group or project.
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
PUT /groups/:id/members/:user_id
PUT /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `user_id` | integer | yes | The user ID of the member |
| `access_level` | integer | yes | A valid access level |
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40"
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/:user_id?access_level=40"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
2018-11-18 11:00:15 +05:30
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
2020-04-08 14:13:33 +05:30
"access_level": 40,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-04-08 14:13:33 +05:30
"group_saml_identity": null
2016-09-13 17:45:13 +05:30
}
```
2020-05-24 23:13:21 +05:30
### Set override flag for a member of a group
2020-07-28 23:09:34 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0.
2020-05-24 23:13:21 +05:30
By default, the access level of LDAP group members is set to the value specified
by LDAP through Group Sync. You can allow access level overrides by calling this endpoint.
```plaintext
POST /groups/:id/members/:user_id/override
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member |
2020-06-23 00:09:42 +05:30
```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override"
2020-05-24 23:13:21 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
"access_level": 40,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-05-24 23:13:21 +05:30
"override": true
}
```
### Remove override for a member of a group
2020-07-28 23:09:34 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4875) in GitLab 13.0.
2020-05-24 23:13:21 +05:30
Sets the override flag to false and allows LDAP Group Sync to reset the access
level to the LDAP-prescribed value.
```plaintext
DELETE /groups/:id/members/:user_id/override
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member |
2020-06-23 00:09:42 +05:30
```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override"
2020-05-24 23:13:21 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
"access_level": 40,
2020-10-24 23:57:45 +05:30
"email": "john@example.com",
2020-05-24 23:13:21 +05:30
"override": false
}
```
2016-09-13 17:45:13 +05:30
## Remove a member from a group or project
Removes a user from a group or project.
2020-04-08 14:13:33 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
DELETE /groups/:id/members/:user_id
DELETE /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-09-13 17:45:13 +05:30
| `user_id` | integer | yes | The user ID of the member |
2020-07-28 23:09:34 +05:30
| `unassign_issuables` | boolean | false | Flag indicating if the removed member should be unassigned from any issues or merge requests within given group or project |
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id"
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/:user_id"
2016-09-13 17:45:13 +05:30
```
2018-11-08 19:23:39 +05:30
## Give a group access to a project
2020-06-23 00:09:42 +05:30
See [share project with group](projects.md#share-project-with-group)