summaryrefslogtreecommitdiff
path: root/doc/api/members.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-05-11 21:08:09 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-05-11 21:08:09 +0000
commitfdc26e021b1e3eea4161bf6891f3a151fb7414b0 (patch)
treef06ce58930f41f8d031e827df198fed5dfab09be /doc/api/members.md
parent11df4bf91b8cf9ac7bb601241992e300eebf684c (diff)
downloadgitlab-ce-fdc26e021b1e3eea4161bf6891f3a151fb7414b0.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/members.md')
-rw-r--r--doc/api/members.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/api/members.md b/doc/api/members.md
index 21ed6db7245..1db9714bfd1 100644
--- a/doc/api/members.md
+++ b/doc/api/members.md
@@ -483,6 +483,35 @@ DELETE /groups/:id/billable_members/:user_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/billable_members/:user_id"
```
+## Change membership state of a user in a group
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86705) in GitLab 15.0.
+
+Changes the membership state of a user in a group. The state is applied to
+all subgroups and projects.
+
+```plaintext
+PUT /groups/:id/members/:user_id/state
+```
+
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user. |
+| `user_id` | integer | yes | The user ID of the member. |
+| `state` | string | yes | The new state for the user. State is either `awaiting` or `active`. |
+
+```shell
+curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id/state?state=active"
+```
+
+Example response:
+
+```json
+{
+ "success":true
+}
+```
+
## Add a member to a group or project
Adds a member to a group or project.