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

632 lines
23 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-02-22 17:27:13 +05:30
stage: Manage
group: Access
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-11-11 11:23:49 +05:30
# Group and project members API **(FREE)**
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`)
2021-02-22 17:27:13 +05:30
- Minimal access (`5`) ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220203) in GitLab 13.5.)
2020-06-23 00:09:42 +05:30
- Guest (`10`)
- Reporter (`20`)
- Developer (`30`)
- Maintainer (`40`)
- Owner (`50`) - Only valid to set for groups
2021-02-22 17:27:13 +05:30
WARNING:
2020-06-23 00:09:42 +05:30
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
2021-02-22 17:27:13 +05:30
projects in personal namespaces don't show owner (`50`) permission
2020-06-23 00:09:42 +05:30
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).
2021-10-27 15:23:28 +05:30
The `email` attribute is only visible for users with public emails.
2020-10-24 23:57:45 +05:30
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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.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.
2021-04-29 21:17:54 +05:30
If a user is a member of this group or project and also of one or more ancestor groups,
only its membership with the highest `access_level` is returned.
2021-11-11 11:23:49 +05:30
([Improved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56677) in GitLab 13.11.)
2021-04-29 21:17:54 +05:30
This represents the effective permission of the user.
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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-11-18 11:00:15 +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 |
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",
2021-06-08 01:23:25 +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
},
{
"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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.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",
2021-01-03 14:25:43 +05:30
"created_at": "2012-10-22T14:13:35Z",
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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-12-21 20:55:43 +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/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
}
```
2021-01-03 14:25:43 +05:30
## List all billable members of a group
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217384) in GitLab 13.5.
Gets a list of group members that count as billable. The list includes members in the subgroup or subproject.
2021-04-17 20:07:23 +05:30
This API endpoint works on top-level groups only. It does not work on subgroups.
2021-01-03 14:25:43 +05:30
NOTE:
Unlike other API endpoints, billable members is updated once per day at 12:00 UTC.
2021-09-30 23:02:18 +05:30
This function takes [pagination](index.md#pagination) parameters `page` and `per_page` to restrict the list of users.
2021-01-03 14:25:43 +05:30
2021-02-22 17:27:13 +05:30
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262875) in GitLab 13.7, the `search` and
`sort` parameters allow you to search for billable group members by name and sort the results,
respectively.
2021-01-03 14:25:43 +05:30
```plaintext
GET /groups/:id/billable_members
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-02-22 17:27:13 +05:30
| `search` | string | no | A query string to search for group members by name, username, or email. |
| `sort` | string | no | A query string containing parameters that specify the sort attribute and order. See supported values below.|
The supported values for the `sort` attribute are:
2021-09-30 23:02:18 +05:30
| Value | Description |
| ----------------------- | ---------------------------- |
| `access_level_asc` | Access level, ascending |
| `access_level_desc` | Access level, descending |
| `last_joined` | Last joined |
| `name_asc` | Name, ascending |
| `name_desc` | Name, descending |
| `oldest_joined` | Oldest joined |
| `oldest_sign_in` | Oldest sign in |
| `recent_sign_in` | Recent sign in |
| `last_activity_on_asc` | Last active date, ascending |
| `last_activity_on_desc` | Last active date, descending |
2021-01-03 14:25:43 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/billable_members"
```
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",
2021-06-08 01:23:25 +05:30
"last_activity_on": "2021-01-27",
"membership_type": "group_member",
2021-10-27 15:23:28 +05:30
"removable": true,
"created_at": "2021-01-03T12:16:02.000Z"
2021-01-03 14:25:43 +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",
2021-03-11 19:13:27 +05:30
"email": "john@example.com",
2021-06-08 01:23:25 +05:30
"last_activity_on": "2021-01-25",
"membership_type": "group_member",
2021-10-27 15:23:28 +05:30
"removable": true,
"created_at": "2021-01-04T18:46:42.000Z"
2021-01-03 14:25:43 +05:30
},
{
"id": 3,
"username": "foo_bar",
"name": "Foo bar",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
2021-03-11 19:13:27 +05:30
"web_url": "http://192.168.1.8:3000/root",
2021-06-08 01:23:25 +05:30
"last_activity_on": "2021-01-20",
"membership_type": "group_invite",
2021-10-27 15:23:28 +05:30
"removable": false,
"created_at": "2021-01-09T07:12:31.000Z"
2021-01-03 14:25:43 +05:30
}
]
```
2021-04-29 21:17:54 +05:30
## List memberships for a billable member of a group
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/321560) in GitLab 13.11.
Gets a list of memberships for a billable member of a group.
Lists all projects and groups a user is a member of. Only projects and groups within the group hierarchy are included.
For instance, if the requested group is `Root Group`, and the requested user is a direct member of both `Root Group / Sub Group One` and `Other Group / Sub Group Two`, then only `Root Group / Sub Group One` will be returned, because `Other Group / Sub Group Two` is not within the `Root Group` hierarchy.
The response represents only direct memberships. Inherited memberships are not included.
This API endpoint works on top-level groups only. It does not work on subgroups.
2021-11-18 22:05:49 +05:30
This API endpoint requires permission to administer memberships for the group.
2021-04-29 21:17:54 +05:30
2021-09-30 23:02:18 +05:30
This API endpoint takes [pagination](index.md#pagination) parameters `page` and `per_page` to restrict the list of memberships.
2021-04-29 21:17:54 +05:30
```plaintext
GET /groups/:id/billable_members/:user_id/memberships
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-04-29 21:17:54 +05:30
| `user_id` | integer | yes | The user ID of the billable member |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/billable_members/:user_id/memberships"
```
Example response:
```json
[
{
"id": 168,
"source_id": 131,
"source_full_name": "Root Group / Sub Group One",
"source_members_url": "https://gitlab.example.com/groups/root-group/sub-group-one/-/group_members",
"created_at": "2021-03-31T17:28:44.812Z",
"expires_at": "2022-03-21",
"access_level": {
"string_value": "Developer",
"integer_value": 30
}
},
{
"id": 169,
"source_id": 63,
"source_full_name": "Root Group / Sub Group One / My Project",
"source_members_url": "https://gitlab.example.com/root-group/sub-group-one/my-project/-/project_members",
"created_at": "2021-03-31T17:29:14.934Z",
"expires_at": null,
"access_level": {
"string_value": "Maintainer",
"integer_value": 40
}
}
]
```
2021-04-17 20:07:23 +05:30
## Remove a billable member from a group
Removes a billable member from a group and its subgroups and projects.
The user does not need to be a group member to qualify for removal.
For example, if the user was added directly to a project within the group, you can
still use this API to remove them.
```plaintext
DELETE /groups/:id/billable_members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-04-17 20:07:23 +05:30
| `user_id` | integer | yes | The user ID of the member |
```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/billable_members/:user_id"
```
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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-01-03 14:25:43 +05:30
| `user_id` | integer/string | yes | The user ID of the new member or multiple IDs separated by commas |
2016-09-13 17:45:13 +05:30
| `access_level` | integer | yes | A valid access level |
2021-03-11 19:13:27 +05:30
| `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` |
2021-09-04 01:27:46 +05:30
| `invite_source` | string | no | The source of the invitation that starts the member creation process. See [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/327120). |
2021-10-27 15:23:28 +05:30
| `areas_of_focus` | string | no | Areas the inviter wants the member to focus upon. |
2021-12-11 22:18:48 +05:30
| `tasks_to_be_done` | array of strings | no | Tasks the inviter wants the member to focus on. The tasks are added as issues to a specified project. The possible values are: `ci`, `code` and `issues`. If specified, requires `tasks_project_id`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69299) in GitLab 14.5 [with a flag](../administration/feature_flags.md) named `invite_members_for_task`. Disabled by default. |
| `tasks_project_id` | integer | no | The project ID in which to create the task issues. If specified, requires `tasks_to_be_done`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69299) in GitLab 14.5 [with a flag](../administration/feature_flags.md) named `invite_members_for_task`. Disabled by default. |
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.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 |
2021-03-11 19:13:27 +05:30
| `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` |
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 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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `user_id` | integer | yes | The user ID of the member |
2020-06-23 00:09:42 +05:30
```shell
2021-03-08 18:12:59 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "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 |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `user_id` | integer | yes | The user ID of the member |
2020-06-23 00:09:42 +05:30
```shell
2021-03-08 18:12:59 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "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",
2021-11-11 11:23:49 +05:30
"expires_at": "2012-10-22",
2020-05-24 23:13:21 +05:30
"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
2021-11-18 22:05:49 +05:30
Removes a user from a group or project where the user has been explicitly assigned a role.
The user needs to be a group member to qualify for removal.
For example, if the user was added directly to a project within the group but not this
group explicitly, you cannot use this API to remove them. See
[Remove a billable member from a group](#remove-a-billable-member-from-a-group) for an alternative approach.
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
DELETE /groups/:id/members/:user_id
DELETE /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](index.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 |
2021-04-29 21:17:54 +05:30
| `skip_subresources` | boolean | false | Whether the deletion of direct memberships of the removed member in subgroups and projects should be skipped. Default is `false`. |
| `unassign_issuables` | boolean | false | Whether the removed member should be unassigned from any issues or merge requests inside a given group or project. Default is `false`. |
Example request:
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
2021-12-11 22:18:48 +05:30
## Approve a member for a group
Approves a pending user for a group and its subgroups and projects.
```plaintext
PUT /groups/:id/members/:user_id/approve
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](index.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member |
Example request:
```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/approve"
```
## Approve all pending members for a group
Approves all pending users for a group and its subgroups and projects.
```plaintext
POST /groups/:id/members/approve_all
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](index.md#namespaced-path-encoding) owned by the authenticated user |
Example request:
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/approve_all"
```
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)