diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-22 15:08:48 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-22 15:08:48 +0000 |
commit | 180cd023a11c0eb413ad0de124d9758ea25672bd (patch) | |
tree | 63d77be00a22dc637daa0b6d5b644e230f5f4890 /doc/api/users.md | |
parent | be3e24ea3c9f497efde85900df298ce9bc42fce8 (diff) | |
download | gitlab-ce-180cd023a11c0eb413ad0de124d9758ea25672bd.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/users.md')
-rw-r--r-- | doc/api/users.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 4ba524d6d1d..7694345d08b 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -1405,3 +1405,53 @@ Example response: ``` Please note that `last_activity_at` is deprecated, please use `last_activity_on`. + +## User memberships (admin only) + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/22518) in GitLab 12.8. + +Lists all projects and groups a user is a member of. This endpoint is available for admins only. +It returns the `source_id`, `source_name`, `source_type` and `access_level` of a membership. +Source can be of type `Namespace` (representing a group) or `Project`. The response represents only direct memberships. Inherited memberships, for example in subgroups, will not be included. +Access levels will be represented by an integer value. Read more about the meaning of access level values [here](access_requests.md#valid-access-levels). + +``` +GET /users/:id/memberships +``` + +Parameters: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer | yes | The ID of a specified user | +| `type` | string | no | Filter memberships by type. Can be either `Project` or `Namespace` | + +Returns: + +- `200 OK` on success. +- `404 User Not Found` if user cannot be found. +- `403 Forbidden` when not requested by an admin. +- `400 Bad Request` when requested type is not supported. + +```bash +curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/<user_id>/memberships +``` + +Example response: + +```json +[ + { + "source_id": 1, + "source_name": "Project one", + "source_type": "Project", + "access_level": "20" + }, + { + "source_id": 3, + "source_name": "Group three", + "source_type": "Namespace", + "access_level": "20" + }, +] +``` |