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

1739 lines
62 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-03-11 19:13:27 +05:30
stage: Manage
group: Access
2021-02-22 17:27:13 +05:30
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
---
2017-09-10 17:25:29 +05:30
# Users API
2014-09-02 18:07:02 +05:30
## List users
Get a list of users.
This function takes pagination parameters `page` and `per_page` to restrict the list of users.
### For normal users
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /users
```
```json
[
{
"id": 1,
"username": "john_smith",
"name": "John Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/john_smith"
2014-09-02 18:07:02 +05:30
},
{
"id": 2,
"username": "jack_smith",
"name": "Jack Smith",
"state": "blocked",
"avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/jack_smith"
2014-09-02 18:07:02 +05:30
}
]
```
2019-07-31 22:56:46 +05:30
You can also search for users by name or primary email using `?search=`. For example. `/users?search=John`.
2018-11-18 11:00:15 +05:30
In addition, you can lookup users by username:
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
GET /users?username=:username
```
For example:
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
GET /users?username=jack_smith
```
2021-04-17 20:07:23 +05:30
NOTE:
Username search is case insensitive.
2020-11-24 15:15:51 +05:30
In addition, you can filter users based on the states `blocked` and `active`.
2021-02-22 17:27:13 +05:30
It does not support `active=false` or `blocked=false`. The list of billable users
2020-11-24 15:15:51 +05:30
is the total number of users minus the blocked users.
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users?active=true
```
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users?blocked=true
```
2021-04-17 20:07:23 +05:30
In addition, you can search for external users only with `external=true`.
It does not support `external=false`.
```plaintext
GET /users?external=true
```
2021-03-11 19:13:27 +05:30
GitLab supports bot users such as the [alert bot](../operations/incident_management/integrations.md)
2020-11-24 15:15:51 +05:30
or the [support bot](../user/project/service_desk.md#support-bot-user).
2021-04-17 20:07:23 +05:30
You can exclude the following types of [internal users](../development/internal_users.md#internal-users)
from the users' list, with the `exclude_internal=true` parameter,
2020-11-24 15:15:51 +05:30
([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241144) in GitLab 13.4).
2021-04-17 20:07:23 +05:30
- Alert bot
- Support bot
However, this action does not exclude [project bot users](../user/project/settings/project_access_tokens.md#project-bot-users).
2020-11-24 15:15:51 +05:30
```plaintext
GET /users?exclude_internal=true
```
2021-04-17 20:07:23 +05:30
In addition, to exclude external users from the users' list, you can use the parameter `exclude_external=true`.
```plaintext
GET /users?exclude_external=true
```
2018-12-13 13:39:08 +05:30
2014-09-02 18:07:02 +05:30
### For admins
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /users
```
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| ------------------ | ------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `order_by` | string | no | Return users ordered by `id`, `name`, `username`, `created_at`, or `updated_at` fields. Default is `id` |
| `sort` | string | no | Return users sorted in `asc` or `desc` order. Default is `desc` |
| `two_factor` | string | no | Filter users by Two-factor authentication. Filter values are `enabled` or `disabled`. By default it returns all users |
2021-03-11 19:13:27 +05:30
| `without_projects` | boolean | no | Filter users without projects. Default is `false`, which means that all users are returned, with and without projects. |
2021-03-08 18:12:59 +05:30
| `admins` | boolean | no | Return only admin users. Default is `false` |
2018-03-17 18:26:18 +05:30
2014-09-02 18:07:02 +05:30
```json
[
{
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
2016-06-02 11:05:42 +05:30
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/john_smith",
2014-09-02 18:07:02 +05:30
"created_at": "2012-05-23T08:00:58Z",
2016-06-02 11:05:42 +05:30
"is_admin": false,
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2016-06-02 11:05:42 +05:30
"location": null,
2014-09-02 18:07:02 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
2016-11-03 12:29:30 +05:30
"organization": "",
2020-04-08 14:13:33 +05:30
"job_title": "",
2016-06-02 11:05:42 +05:30
"last_sign_in_at": "2012-06-01T11:41:01Z",
"confirmed_at": "2012-05-23T09:05:22Z",
2018-03-17 18:26:18 +05:30
"theme_id": 1,
2017-08-17 22:00:37 +05:30
"last_activity_on": "2012-05-23",
2014-09-02 18:07:02 +05:30
"color_scheme_id": 2,
2016-06-02 11:05:42 +05:30
"projects_limit": 100,
"current_sign_in_at": "2012-06-02T06:36:55Z",
2020-06-23 00:09:42 +05:30
"note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123",
2016-06-02 11:05:42 +05:30
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john.smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
2015-09-11 14:41:01 +05:30
"can_create_group": true,
2016-06-02 11:05:42 +05:30
"can_create_project": true,
"two_factor_enabled": true,
2018-11-18 11:00:15 +05:30
"external": false,
2020-03-13 15:44:24 +05:30
"private_profile": false,
"current_sign_in_ip": "196.165.1.102",
"last_sign_in_ip": "172.127.2.22"
2014-09-02 18:07:02 +05:30
},
{
"id": 2,
"username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"state": "blocked",
2016-06-02 11:05:42 +05:30
"avatar_url": "http://localhost:3000/uploads/user/avatar/2/index.jpg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/jack_smith",
2014-09-02 18:07:02 +05:30
"created_at": "2012-05-23T08:01:01Z",
2016-06-02 11:05:42 +05:30
"is_admin": false,
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2016-06-02 11:05:42 +05:30
"location": null,
2014-09-02 18:07:02 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
2016-11-03 12:29:30 +05:30
"organization": "",
2020-04-08 14:13:33 +05:30
"job_title": "",
2016-06-02 11:05:42 +05:30
"last_sign_in_at": null,
"confirmed_at": "2012-05-30T16:53:06.148Z",
2018-03-17 18:26:18 +05:30
"theme_id": 1,
2017-08-17 22:00:37 +05:30
"last_activity_on": "2012-05-23",
2014-09-02 18:07:02 +05:30
"color_scheme_id": 3,
2015-09-11 14:41:01 +05:30
"projects_limit": 100,
"current_sign_in_at": "2014-03-19T17:54:13Z",
2016-06-02 11:05:42 +05:30
"identities": [],
"can_create_group": true,
"can_create_project": true,
"two_factor_enabled": true,
2018-11-18 11:00:15 +05:30
"external": false,
2020-03-13 15:44:24 +05:30
"private_profile": false,
"current_sign_in_ip": "10.165.1.102",
"last_sign_in_ip": "172.127.2.22"
2014-09-02 18:07:02 +05:30
}
]
```
2021-03-11 19:13:27 +05:30
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `using_license_seat` parameters.
2019-09-30 21:07:59 +05:30
```json
[
{
"id": 1,
...
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133,
2021-02-22 17:27:13 +05:30
"using_license_seat": true
2019-09-30 21:07:59 +05:30
...
}
]
```
2021-03-11 19:13:27 +05:30
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see
2019-09-30 21:07:59 +05:30
the `group_saml` provider option:
```json
[
{
"id": 1,
...
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john.smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"},
{"provider": "group_saml", "extern_uid": "123789", "saml_provider_id": 10}
],
...
}
]
```
2018-11-18 11:00:15 +05:30
You can lookup users by external UID and provider:
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users?extern_uid=:extern_uid&provider=:provider
```
For example:
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users?extern_uid=1234567&provider=github
```
2017-09-10 17:25:29 +05:30
You can search users by creation date time range with:
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /users?created_before=2001-01-02T00:00:00.060Z&created_after=1999-01-02T00:00:00.060
```
2020-04-22 19:07:51 +05:30
You can search for users without projects with: `/users?without_projects=true`
2018-03-17 18:26:18 +05:30
You can filter by [custom attributes](custom_attributes.md) with:
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /users?custom_attributes[key]=value&custom_attributes[other_key]=other_value
```
2018-03-27 19:54:05 +05:30
You can include the users' [custom attributes](custom_attributes.md) in the response with:
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /users?with_custom_attributes=true
```
2014-09-02 18:07:02 +05:30
## Single user
Get a single user.
### For user
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /users/:id
```
Parameters:
- `id` (required) - The ID of a user
```json
{
"id": 1,
"username": "john_smith",
"name": "John Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/john_smith",
"created_at": "2012-05-23T08:00:58Z",
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2021-03-11 19:13:27 +05:30
"bot": false,
2016-06-02 11:05:42 +05:30
"location": null,
2018-12-05 23:21:45 +05:30
"public_email": "john@example.com",
"skype": "",
"linkedin": "",
"twitter": "",
2016-11-03 12:29:30 +05:30
"website_url": "",
2020-04-08 14:13:33 +05:30
"organization": "",
2021-03-11 19:13:27 +05:30
"job_title": "Operations Specialist",
"followers": 1,
"following": 1
2014-09-02 18:07:02 +05:30
}
```
### For admin
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /users/:id
```
Parameters:
- `id` (required) - The ID of a user
2019-09-30 21:07:59 +05:30
Example Responses:
2014-09-02 18:07:02 +05:30
```json
{
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
2016-06-02 11:05:42 +05:30
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/john_smith",
2014-09-02 18:07:02 +05:30
"created_at": "2012-05-23T08:00:58Z",
2016-06-02 11:05:42 +05:30
"is_admin": false,
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2016-06-02 11:05:42 +05:30
"location": null,
2018-12-05 23:21:45 +05:30
"public_email": "john@example.com",
2014-09-02 18:07:02 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
2016-11-03 12:29:30 +05:30
"organization": "",
2020-04-08 14:13:33 +05:30
"job_title": "Operations Specialist",
2016-06-02 11:05:42 +05:30
"last_sign_in_at": "2012-06-01T11:41:01Z",
"confirmed_at": "2012-05-23T09:05:22Z",
2018-03-17 18:26:18 +05:30
"theme_id": 1,
2017-08-17 22:00:37 +05:30
"last_activity_on": "2012-05-23",
2014-09-02 18:07:02 +05:30
"color_scheme_id": 2,
2016-06-02 11:05:42 +05:30
"projects_limit": 100,
"current_sign_in_at": "2012-06-02T06:36:55Z",
2020-06-23 00:09:42 +05:30
"note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123",
2016-06-02 11:05:42 +05:30
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john.smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
2014-09-02 18:07:02 +05:30
"can_create_group": true,
2015-04-26 12:48:37 +05:30
"can_create_project": true,
2016-06-02 11:05:42 +05:30
"two_factor_enabled": true,
2018-11-18 11:00:15 +05:30
"external": false,
2020-03-13 15:44:24 +05:30
"private_profile": false,
"current_sign_in_ip": "196.165.1.102",
2020-04-08 14:13:33 +05:30
"last_sign_in_ip": "172.127.2.22",
"plan": "gold",
2020-10-24 23:57:45 +05:30
"trial": true,
"sign_in_count": 1337
2019-09-30 21:07:59 +05:30
}
```
2021-02-22 17:27:13 +05:30
NOTE:
2020-07-28 23:09:34 +05:30
The `plan` and `trial` parameters are only available on GitLab Enterprise Edition.
2020-04-08 14:13:33 +05:30
2021-03-11 19:13:27 +05:30
Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see
2020-06-23 00:09:42 +05:30
the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters.
2019-09-30 21:07:59 +05:30
```json
{
"id": 1,
"username": "john_smith",
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133,
...
}
```
2021-03-11 19:13:27 +05:30
Users on GitLab.com [Premium or higher](https://about.gitlab.com/pricing/) also
2019-09-30 21:07:59 +05:30
see the `group_saml` option:
```json
{
"id": 1,
"username": "john_smith",
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133,
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john.smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"},
{"provider": "group_saml", "extern_uid": "123789", "saml_provider_id": 10}
],
...
2014-09-02 18:07:02 +05:30
}
```
2018-03-27 19:54:05 +05:30
You can include the user's [custom attributes](custom_attributes.md) in the response with:
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /users/:id?with_custom_attributes=true
```
2014-09-02 18:07:02 +05:30
## User creation
2019-09-30 21:07:59 +05:30
Creates a new user. Note only administrators can create new
users. Either `password`, `reset_password`, or `force_random_password`
must be specified. If `reset_password` and `force_random_password` are
both `false`, then `password` is required.
Note that `force_random_password` and `reset_password` take priority
over `password`. In addition, `reset_password` and
`force_random_password` can be used together.
2014-09-02 18:07:02 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29888/), `private_profile` defaults to `false`.
2019-10-12 21:52:04 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35604), `bio` defaults to `""` instead of `null`.
2020-07-28 23:09:34 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
POST /users
```
Parameters:
2020-04-08 14:13:33 +05:30
| Attribute | Required | Description |
2020-06-23 00:09:42 +05:30
| :----------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
2020-04-08 14:13:33 +05:30
| `admin` | No | User is admin - true or false (default) |
| `avatar` | No | Image file for user's avatar |
| `bio` | No | User's biography |
| `can_create_group` | No | User can create groups - true or false |
| `color_scheme_id` | No | User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) |
| `email` | Yes | Email |
| `extern_uid` | No | External UID |
| `external` | No | Flags the user as external - true or false (default) |
2020-07-28 23:09:34 +05:30
| `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user (purchased in addition to the minutes included in the plan) **(STARTER)** |
2020-04-08 14:13:33 +05:30
| `force_random_password` | No | Set user password to a random value - true or false (default) |
| `group_id_for_saml` | No | ID of group where SAML has been configured |
| `linkedin` | No | LinkedIn |
| `location` | No | User's location |
2020-04-22 19:07:51 +05:30
| `name` | Yes | Name |
2020-06-23 00:09:42 +05:30
| `note` | No | Admin notes for this user |
2020-04-08 14:13:33 +05:30
| `organization` | No | Organization name |
| `password` | No | Password |
2021-02-22 17:27:13 +05:30
| `private_profile` | No | User's profile is private - true, false (default), or null (is converted to false) |
2020-04-08 14:13:33 +05:30
| `projects_limit` | No | Number of projects user can create |
| `provider` | No | External provider name |
| `public_email` | No | The public email of the user |
| `reset_password` | No | Send user password reset link - true or false(default) |
2020-07-28 23:09:34 +05:30
| `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` **(STARTER)** |
2020-04-08 14:13:33 +05:30
| `skip_confirmation` | No | Skip confirmation - true or false (default) |
| `skype` | No | Skype ID |
| `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) |
| `twitter` | No | Twitter account |
| `username` | Yes | Username |
2021-04-17 20:07:23 +05:30
| `view_diffs_file_by_file` | No | Flag indicating the user sees only one file diff per page |
2020-04-08 14:13:33 +05:30
| `website_url` | No | Website URL |
2014-09-02 18:07:02 +05:30
## User modification
Modifies an existing user. Only administrators can change attributes of a user.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
PUT /users/:id
```
Parameters:
2020-04-08 14:13:33 +05:30
| Attribute | Required | Description |
2020-06-23 00:09:42 +05:30
| :----------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
2020-04-08 14:13:33 +05:30
| `admin` | No | User is admin - true or false (default) |
| `avatar` | No | Image file for user's avatar |
| `bio` | No | User's biography |
| `can_create_group` | No | User can create groups - true or false |
| `color_scheme_id` | No | User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) |
| `email` | No | Email |
| `extern_uid` | No | External UID |
| `external` | No | Flags the user as external - true or false (default) |
2020-07-28 23:09:34 +05:30
| `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user (purchased in addition to the minutes included in the plan) **(STARTER)** |
2020-04-08 14:13:33 +05:30
| `group_id_for_saml` | No | ID of group where SAML has been configured |
| `id` | Yes | The ID of the user |
| `linkedin` | No | LinkedIn |
| `location` | No | User's location |
| `name` | No | Name |
2020-06-23 00:09:42 +05:30
| `note` | No | Admin notes for this user |
2020-04-08 14:13:33 +05:30
| `organization` | No | Organization name |
| `password` | No | Password |
2021-02-22 17:27:13 +05:30
| `private_profile` | No | User's profile is private - true, false (default), or null (is converted to false) |
2020-04-08 14:13:33 +05:30
| `projects_limit` | No | Limit projects each user can create |
| `provider` | No | External provider name |
| `public_email` | No | The public email of the user |
2020-07-28 23:09:34 +05:30
| `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` **(STARTER)** |
2020-04-08 14:13:33 +05:30
| `skip_reconfirmation` | No | Skip reconfirmation - true or false (default) |
| `skype` | No | Skype ID |
| `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) |
| `twitter` | No | Twitter account |
| `username` | No | Username |
2021-04-17 20:07:23 +05:30
| `view_diffs_file_by_file` | No | Flag indicating the user sees only one file diff per page |
2020-04-08 14:13:33 +05:30
| `website_url` | No | Website URL |
2014-09-02 18:07:02 +05:30
2021-02-22 17:27:13 +05:30
On password update, the user is forced to change it upon next login.
2017-08-17 22:00:37 +05:30
Note, at the moment this method does only return a `404` error,
2020-04-08 14:13:33 +05:30
even in cases where a `409` (Conflict) would be more appropriate.
For example, when renaming the email address to some existing one.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
## Delete authentication identity from user
Deletes a user's authentication identity using the provider name associated with that identity. Available only for administrators.
2020-04-08 14:13:33 +05:30
```plaintext
2020-03-13 15:44:24 +05:30
DELETE /users/:id/identities/:provider
```
Parameters:
- `id` (required) - The ID of the user
- `provider` (required) - External provider name
2014-09-02 18:07:02 +05:30
## User deletion
Deletes a user. Available only for administrators.
2020-01-01 13:55:28 +05:30
This returns a `204 No Content` status code if the operation was successfully, `404` if the resource was not found or `409` if the user cannot be soft deleted.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
DELETE /users/:id
```
Parameters:
- `id` (required) - The ID of the user
2017-09-10 17:25:29 +05:30
- `hard_delete` (optional) - If true, contributions that would usually be
[moved to the ghost user](../user/profile/account/delete_account.md#associated-records)
2021-02-22 17:27:13 +05:30
are deleted instead, as well as groups owned solely by this user.
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
## List current user (for normal users)
2014-09-02 18:07:02 +05:30
Gets currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /user
```
```json
{
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
2016-06-02 11:05:42 +05:30
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
2016-11-03 12:29:30 +05:30
"web_url": "http://localhost:3000/john_smith",
2014-09-02 18:07:02 +05:30
"created_at": "2012-05-23T08:00:58Z",
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2016-06-02 11:05:42 +05:30
"location": null,
2018-12-05 23:21:45 +05:30
"public_email": "john@example.com",
2014-09-02 18:07:02 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
2016-11-03 12:29:30 +05:30
"organization": "",
2016-06-02 11:05:42 +05:30
"last_sign_in_at": "2012-06-01T11:41:01Z",
"confirmed_at": "2012-05-23T09:05:22Z",
2018-03-17 18:26:18 +05:30
"theme_id": 1,
2017-08-17 22:00:37 +05:30
"last_activity_on": "2012-05-23",
2014-09-02 18:07:02 +05:30
"color_scheme_id": 2,
2016-06-02 11:05:42 +05:30
"projects_limit": 100,
"current_sign_in_at": "2012-06-02T06:36:55Z",
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john_smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
2014-09-02 18:07:02 +05:30
"can_create_group": true,
2015-04-26 12:48:37 +05:30
"can_create_project": true,
2016-06-02 11:05:42 +05:30
"two_factor_enabled": true,
2018-11-18 11:00:15 +05:30
"external": false,
"private_profile": false
2014-09-02 18:07:02 +05:30
}
```
2019-09-30 21:07:59 +05:30
## List current user (for admins)
2017-01-15 13:20:01 +05:30
Parameters:
2017-09-10 17:25:29 +05:30
- `sudo` (optional) - the ID of a user to make the call in their place
2017-01-15 13:20:01 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-01-15 13:20:01 +05:30
GET /user
```
```json
{
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
"web_url": "http://localhost:3000/john_smith",
"created_at": "2012-05-23T08:00:58Z",
"is_admin": false,
2020-07-28 23:09:34 +05:30
"bio": "",
"bio_html": "",
2017-01-15 13:20:01 +05:30
"location": null,
2018-12-05 23:21:45 +05:30
"public_email": "john@example.com",
2017-01-15 13:20:01 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": "",
2020-04-08 14:13:33 +05:30
"job_title": "",
2017-01-15 13:20:01 +05:30
"last_sign_in_at": "2012-06-01T11:41:01Z",
"confirmed_at": "2012-05-23T09:05:22Z",
2018-03-17 18:26:18 +05:30
"theme_id": 1,
2017-08-17 22:00:37 +05:30
"last_activity_on": "2012-05-23",
2017-01-15 13:20:01 +05:30
"color_scheme_id": 2,
"projects_limit": 100,
"current_sign_in_at": "2012-06-02T06:36:55Z",
"identities": [
{"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john_smith"},
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
"can_create_group": true,
"can_create_project": true,
"two_factor_enabled": true,
2018-11-18 11:00:15 +05:30
"external": false,
2020-03-13 15:44:24 +05:30
"private_profile": false,
"current_sign_in_ip": "196.165.1.102",
"last_sign_in_ip": "172.127.2.22"
2018-11-18 11:00:15 +05:30
}
```
## User status
Get the status of the currently signed in user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
GET /user/status
```
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/user/status"
2018-11-18 11:00:15 +05:30
```
Example response:
```json
{
"emoji":"coffee",
"message":"I crave coffee :coffee:",
2021-03-11 19:13:27 +05:30
"message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\"></gl-emoji>",
"clear_status_at": null
2018-11-18 11:00:15 +05:30
}
```
## Get the status of a user
Get the status of a user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
GET /users/:id_or_username/status
```
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| ---------------- | ------ | -------- | ------------------------------------------------- |
2020-05-24 23:13:21 +05:30
| `id_or_username` | string | yes | The ID or username of the user to get a status of |
2018-11-18 11:00:15 +05:30
2020-03-13 15:44:24 +05:30
```shell
2018-11-18 11:00:15 +05:30
curl "https://gitlab.example.com/users/janedoe/status"
```
Example response:
```json
{
"emoji":"coffee",
"message":"I crave coffee :coffee:",
2021-03-11 19:13:27 +05:30
"message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\"></gl-emoji>",
"clear_status_at": null
2018-11-18 11:00:15 +05:30
}
```
## Set user status
Set the status of the current user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
PUT /user/status
```
2021-03-11 19:13:27 +05:30
| Attribute | Type | Required | Description |
| -------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `emoji` | string | no | The name of the emoji to use as status. If omitted `speech_balloon` is used. Emoji name can be one of the specified names in the [Gemojione index](https://github.com/bonusly/gemojione/blob/master/config/index.json). |
| `message` | string | no | The message to set as a status. It can also contain emoji codes. |
| `clear_status_after` | string | no | Automatically clean up the status after a given time interval, allowed values: `30_minutes`, `3_hours`, `8_hours`, `1_day`, `3_days`, `7_days`, `30_days`
2018-11-18 11:00:15 +05:30
2021-03-11 19:13:27 +05:30
When both parameters `emoji` and `message` are empty, the status is cleared. When the `clear_status_after` parameter is missing from the request, the previously set value for `"clear_status_after` is cleared.
2018-11-18 11:00:15 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-03-11 19:13:27 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "clear_status_after=1_day" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status"
2018-11-18 11:00:15 +05:30
```
Example responses
```json
{
"emoji":"coffee",
"message":"I crave coffee",
2021-03-11 19:13:27 +05:30
"message_html": "I crave coffee",
"clear_status_at":"2021-02-15T10:49:01.311Z"
}
```
## User Follow
### Follow and unfollow users
Follow a user.
```plaintext
POST /users/:id/follow
```
Unfollow a user.
```plaintext
POST /users/:id/unfollow
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | ---------------------------- |
| `id` | integer | yes | The ID of the user to follow |
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/users/3/follow"
```
Example response:
```json
{
"id": 1,
"username": "john_smith",
"name": "John Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
"web_url": "http://localhost:3000/john_smith"
2017-01-15 13:20:01 +05:30
}
```
2021-03-11 19:13:27 +05:30
### Followers and following
Get the followers of a user.
```plaintext
GET /users/:id/followers
```
Get the list of users being followed.
```plaintext
GET /users/:id/following
```
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | ---------------------------- |
| `id` | integer | yes | The ID of the user to follow |
```shell
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/users/3/followers"
```
Example response:
```json
[
{
"id": 2,
"name": "Lennie Donnelly",
"username": "evette.kilback",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/7955171a55ac4997ed81e5976287890a?s=80&d=identicon",
"web_url": "http://127.0.0.1:3000/evette.kilback"
},
{
"id": 4,
"name": "Serena Bradtke",
"username": "cammy",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/a2daad869a7b60d3090b7b9bef4baf57?s=80&d=identicon",
"web_url": "http://127.0.0.1:3000/cammy"
}
]
```
2019-09-30 21:07:59 +05:30
## User counts
Get the counts (same as in top right menu) of the currently signed in user.
2020-06-23 00:09:42 +05:30
| Attribute | Type | Description |
| ---------------- | ------ | ------------------------------------------------------------ |
| `merge_requests` | number | Merge requests that are active and assigned to current user. |
2019-09-30 21:07:59 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-09-30 21:07:59 +05:30
GET /user_counts
```
2020-03-13 15:44:24 +05:30
```shell
2019-09-30 21:07:59 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/user_counts"
```
Example response:
```json
{
"merge_requests": 4
}
```
2018-03-17 18:26:18 +05:30
## List user projects
2019-09-30 21:07:59 +05:30
Please refer to the [List of user projects](projects.md#list-user-projects).
2018-03-17 18:26:18 +05:30
2014-09-02 18:07:02 +05:30
## List SSH keys
Get a list of currently authenticated user's SSH keys.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /user/keys
```
```json
[
{
"id": 1,
"title": "Public key",
2015-04-26 12:48:37 +05:30
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2014-08-01T14:47:39.080Z"
2014-09-02 18:07:02 +05:30
},
{
"id": 3,
"title": "Another Public key",
2015-04-26 12:48:37 +05:30
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2014-08-01T14:47:39.080Z"
2014-09-02 18:07:02 +05:30
}
]
```
Parameters:
- **none**
## List SSH keys for user
2018-12-05 23:21:45 +05:30
Get a list of a specified user's SSH keys.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2020-03-13 15:44:24 +05:30
GET /users/:id_or_username/keys
2014-09-02 18:07:02 +05:30
```
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| ---------------- | ------ | -------- | ------------------------------------------------------- |
2020-05-24 23:13:21 +05:30
| `id_or_username` | string | yes | The ID or username of the user to get the SSH keys for. |
2014-09-02 18:07:02 +05:30
## Single SSH key
Get a single key.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /user/keys/:key_id
2014-09-02 18:07:02 +05:30
```
Parameters:
2017-08-17 22:00:37 +05:30
- `key_id` (required) - The ID of an SSH key
2014-09-02 18:07:02 +05:30
```json
{
"id": 1,
"title": "Public key",
2015-04-26 12:48:37 +05:30
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2014-08-01T14:47:39.080Z"
2014-09-02 18:07:02 +05:30
}
```
## Add SSH key
Creates a new key owned by the currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
POST /user/keys
```
Parameters:
2020-11-24 15:15:51 +05:30
- `title` (required) - new SSH key's title
2020-04-08 14:13:33 +05:30
- `key` (required) - new SSH key
2020-06-23 00:09:42 +05:30
- `expires_at` (optional) - The expiration date of the SSH key in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
```json
{
"title": "ABC",
2020-06-23 00:09:42 +05:30
"key": "ssh-dss AAAAB3NzaC1kc3MAAACBAMLrhYgI3atfrSD6KDas1b/3n6R/HP+bLaHHX6oh+L1vg31mdUqK0Ac/NjZoQunavoyzqdPYhFz9zzOezCrZKjuJDS3NRK9rspvjgM0xYR4d47oNZbdZbwkI4cTv/gcMlquRy0OvpfIvJtjtaJWMwTLtM5VhRusRuUlpH99UUVeXAAAAFQCVyX+92hBEjInEKL0v13c/egDCTQAAAIEAvFdWGq0ccOPbw4f/F8LpZqvWDydAcpXHV3thwb7WkFfppvm4SZte0zds1FJ+Hr8Xzzc5zMHe6J4Nlay/rP4ewmIW7iFKNBEYb/yWa+ceLrs+TfR672TaAgO6o7iSRofEq5YLdwgrwkMmIawa21FrZ2D9SPao/IwvENzk/xcHu7YAAACAQFXQH6HQnxOrw4dqf0NqeKy1tfIPxYYUZhPJfo9O0AmBW2S36pD2l14kS89fvz6Y1g8gN/FwFnRncMzlLY/hX70FSc/3hKBSbH6C6j8hwlgFKfizav21eS358JJz93leOakJZnGb8XlWvz1UJbwCsnR2VEY8Dz90uIk1l/UqHkA= loic@call",
"expires_at": "2016-01-21T00:00:00.000Z"
2015-04-26 12:48:37 +05:30
}
```
2021-02-22 17:27:13 +05:30
Returns a created key with status `201 Created` on success. If an
2015-04-26 12:48:37 +05:30
error occurs a `400 Bad Request` is returned with a message explaining the error:
```json
{
"message": {
"fingerprint": [
"has already been taken"
],
"key": [
"has already been taken"
]
}
}
```
2014-09-02 18:07:02 +05:30
## Add SSH key for user
Create new key owned by specified user. Available only for admin
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
POST /users/:id/keys
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2020-11-24 15:15:51 +05:30
- `title` (required) - new SSH key's title
2020-04-08 14:13:33 +05:30
- `key` (required) - new SSH key
2020-06-23 00:09:42 +05:30
- `expires_at` (optional) - The expiration date of the SSH key in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)
2014-09-02 18:07:02 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2020-11-24 15:15:51 +05:30
This also adds an audit event, as described in [audit instance events](../administration/audit_events.md#instance-events). **(PREMIUM)**
2020-07-28 23:09:34 +05:30
2014-09-02 18:07:02 +05:30
## Delete SSH key for current user
Deletes key owned by currently authenticated user.
2018-03-17 18:26:18 +05:30
This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /user/keys/:key_id
2014-09-02 18:07:02 +05:30
```
Parameters:
2017-08-17 22:00:37 +05:30
- `key_id` (required) - SSH key ID
2014-09-02 18:07:02 +05:30
## Delete SSH key for given user
Deletes key owned by a specified user. Available only for admin.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /users/:id/keys/:key_id
2014-09-02 18:07:02 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2020-04-08 14:13:33 +05:30
- `key_id` (required) - SSH key ID
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
## List all GPG keys
Get a list of currently authenticated user's GPG keys.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /user/gpg_keys
```
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/user/gpg_keys"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
]
```
## Get a specific GPG key
Get a specific GPG key of currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /user/gpg_keys/:key_id
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2019-09-30 21:07:59 +05:30
| `key_id` | integer | yes | The ID of the GPG key |
2018-03-17 18:26:18 +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/user/gpg_keys/1"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
```
## Add a GPG key
Creates a new GPG key owned by the currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
POST /user/gpg_keys
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | --------------- |
2019-09-30 21:07:59 +05:30
| key | string | yes | The new GPG key |
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
]
```
## Delete a GPG key
Delete a GPG key owned by currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
DELETE /user/gpg_keys/:key_id
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
2019-09-30 21:07:59 +05:30
| `key_id` | integer | yes | The ID of the GPG key |
2018-03-17 18:26:18 +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/user/gpg_keys/1"
2018-03-17 18:26:18 +05:30
```
Returns `204 No Content` on success, or `404 Not found` if the key cannot be found.
## List all GPG keys for given user
2021-01-03 14:25:43 +05:30
Get a list of a specified user's GPG keys. This endpoint can be accessed without authentication.
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /users/:id/gpg_keys
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | ------------------ |
2019-09-30 21:07:59 +05:30
| `id` | integer | yes | The ID of the user |
2018-03-17 18:26:18 +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/users/2/gpg_keys"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
]
```
## Get a specific GPG key for a given user
2021-01-03 14:25:43 +05:30
Get a specific GPG key for a given user. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43693)
in GitLab 13.5, this endpoint can be accessed without admin authentication.
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /users/:id/gpg_keys/:key_id
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
| `id` | integer | yes | The ID of the user |
2019-09-30 21:07:59 +05:30
| `key_id` | integer | yes | The ID of the GPG key |
2018-03-17 18:26:18 +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/users/2/gpg_keys/1"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
```
## Add a GPG key for a given user
Create new GPG key owned by the specified user. Available only for admins.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
POST /users/:id/gpg_keys
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
| `id` | integer | yes | The ID of the user |
2019-09-30 21:07:59 +05:30
| `key_id` | integer | yes | The ID of the GPG key |
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 1,
"key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57\r\nvilf4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Slh3TVrLy06YRdq2I4\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI=\r\n=XQoy\r\n-----END PGP PUBLIC KEY BLOCK-----",
"created_at": "2017-09-05T09:17:46.264Z"
}
]
```
## Delete a GPG key for a given user
Delete a GPG key owned by a specified user. Available only for admins.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
DELETE /users/:id/gpg_keys/:key_id
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | --------------------- |
| `id` | integer | yes | The ID of the user |
2019-09-30 21:07:59 +05:30
| `key_id` | integer | yes | The ID of the GPG key |
2018-03-17 18:26:18 +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/users/2/gpg_keys/1"
2018-03-17 18:26:18 +05:30
```
2015-09-11 14:41:01 +05:30
## List emails
Get a list of currently authenticated user's emails.
2021-02-22 17:27:13 +05:30
NOTE:
2020-10-24 23:57:45 +05:30
Due to [a bug](https://gitlab.com/gitlab-org/gitlab/-/issues/25077) this endpoint currently
does not return the primary email address.
2020-04-08 14:13:33 +05:30
```plaintext
2015-09-11 14:41:01 +05:30
GET /user/emails
```
```json
[
{
"id": 1,
"email": "email@example.com"
},
{
"id": 3,
"email": "email2@example.com"
}
]
```
Parameters:
- **none**
## List emails for user
Get a list of a specified user's emails. Available only for admin
2021-02-22 17:27:13 +05:30
NOTE:
2020-10-24 23:57:45 +05:30
Due to [a bug](https://gitlab.com/gitlab-org/gitlab/-/issues/25077) this endpoint currently
does not return the primary email address.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users/:id/emails
2015-09-11 14:41:01 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2015-09-11 14:41:01 +05:30
## Single email
Get a single email.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /user/emails/:email_id
2015-09-11 14:41:01 +05:30
```
Parameters:
2017-08-17 22:00:37 +05:30
- `email_id` (required) - email ID
2015-09-11 14:41:01 +05:30
```json
{
"id": 1,
"email": "email@example.com"
}
```
## Add email
Creates a new email owned by the currently authenticated user.
2020-04-08 14:13:33 +05:30
```plaintext
2015-09-11 14:41:01 +05:30
POST /user/emails
```
Parameters:
- `email` (required) - email address
```json
{
"id": 4,
"email": "email@example.com"
}
```
2021-02-22 17:27:13 +05:30
Returns a created email with status `201 Created` on success. If an
2015-09-11 14:41:01 +05:30
error occurs a `400 Bad Request` is returned with a message explaining the error:
```json
{
"message": {
"email": [
"has already been taken"
]
}
}
```
## Add email for user
Create new email owned by specified user. Available only for admin
2020-04-08 14:13:33 +05:30
```plaintext
2015-09-11 14:41:01 +05:30
POST /users/:id/emails
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2015-09-11 14:41:01 +05:30
- `email` (required) - email address
2018-12-05 23:21:45 +05:30
- `skip_confirmation` (optional) - Skip confirmation and assume e-mail is verified - true or false (default)
2015-09-11 14:41:01 +05:30
## Delete email for current user
Deletes email owned by currently authenticated user.
2018-03-17 18:26:18 +05:30
This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
2015-09-11 14:41:01 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /user/emails/:email_id
2015-09-11 14:41:01 +05:30
```
Parameters:
2017-08-17 22:00:37 +05:30
- `email_id` (required) - email ID
2015-09-11 14:41:01 +05:30
## Delete email for given user
Deletes email owned by a specified user. Available only for admin.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /users/:id/emails/:email_id
2015-09-11 14:41:01 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2020-04-08 14:13:33 +05:30
- `email_id` (required) - email ID
2015-09-11 14:41:01 +05:30
## Block user
2019-12-26 22:10:19 +05:30
Blocks the specified user. Available only for admin.
2015-09-11 14:41:01 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /users/:id/block
2015-09-11 14:41:01 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2015-09-11 14:41:01 +05:30
2020-04-08 14:13:33 +05:30
Returns:
- `201 OK` on success.
- `404 User Not Found` if user cannot be found.
2021-01-03 14:25:43 +05:30
- `403 Forbidden` when trying to block:
- A user that is blocked through LDAP.
- An internal user.
2015-09-11 14:41:01 +05:30
## Unblock user
2019-12-26 22:10:19 +05:30
Unblocks the specified user. Available only for admin.
2015-09-11 14:41:01 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /users/:id/unblock
2015-09-11 14:41:01 +05:30
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2015-09-11 14:41:01 +05:30
2021-02-22 17:27:13 +05:30
Returns `201 OK` on success, `404 User Not Found` is user cannot be found or
`403 Forbidden` when trying to unblock a user blocked by LDAP synchronization.
2016-11-03 12:29:30 +05:30
2019-12-21 20:55:43 +05:30
## Deactivate user
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4.
2019-12-21 20:55:43 +05:30
2020-03-13 15:44:24 +05:30
Deactivates the specified user. Available only for admin.
2019-12-21 20:55:43 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-21 20:55:43 +05:30
POST /users/:id/deactivate
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2019-12-21 20:55:43 +05:30
Returns:
- `201 OK` on success.
- `404 User Not Found` if user cannot be found.
- `403 Forbidden` when trying to deactivate a user:
- Blocked by admin or by LDAP synchronization.
2021-01-03 14:25:43 +05:30
- That has any activity in past 90 days. These users cannot be deactivated.
- That is internal.
2019-12-21 20:55:43 +05:30
## Activate user
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22257) in GitLab 12.4.
2019-12-21 20:55:43 +05:30
2020-03-13 15:44:24 +05:30
Activates the specified user. Available only for admin.
2019-12-21 20:55:43 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-21 20:55:43 +05:30
POST /users/:id/activate
```
Parameters:
2020-05-24 23:13:21 +05:30
- `id` (required) - ID of specified user
2019-12-21 20:55:43 +05:30
Returns:
- `201 OK` on success.
2021-02-22 17:27:13 +05:30
- `404 User Not Found` if the user cannot be found.
- `403 Forbidden` if the user cannot be activated because they are blocked by an administrator or by LDAP synchronization.
2019-12-21 20:55:43 +05:30
2016-11-03 12:29:30 +05:30
### Get user contribution events
2017-09-10 17:25:29 +05:30
Please refer to the [Events API documentation](events.md#get-user-contribution-events)
2016-11-03 12:29:30 +05:30
2017-08-17 22:00:37 +05:30
## Get all impersonation tokens of a user
> Requires admin permissions.
It retrieves every impersonation token of the user. Use the pagination
parameters `page` and `per_page` to restrict the list of impersonation tokens.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users/:user_id/impersonation_tokens
```
Parameters:
2019-09-30 21:07:59 +05:30
| Attribute | Type | Required | Description |
| --------- | ------- | -------- | ---------------------------------------------------------- |
| `user_id` | integer | yes | The ID of the user |
| `state` | string | no | filter tokens based on state (`all`, `active`, `inactive`) |
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens"
2017-08-17 22:00:37 +05:30
```
Example response:
```json
[
{
"active" : true,
2020-10-24 23:57:45 +05:30
"user_id" : 2,
2017-08-17 22:00:37 +05:30
"scopes" : [
"api"
],
"revoked" : false,
"name" : "mytoken",
"id" : 2,
"created_at" : "2017-03-17T17:18:09.283Z",
"impersonation" : true,
"expires_at" : "2017-04-04"
},
{
"active" : false,
2020-10-24 23:57:45 +05:30
"user_id" : 2,
2017-08-17 22:00:37 +05:30
"scopes" : [
"read_user"
],
"revoked" : true,
"name" : "mytoken2",
"created_at" : "2017-03-17T17:19:28.697Z",
"id" : 3,
"impersonation" : true,
"expires_at" : "2017-04-14"
}
]
```
2021-02-22 17:27:13 +05:30
## Approve user
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263107) in GitLab 13.7.
Approves the specified user. Available only for administrators.
```plaintext
POST /users/:id/approve
```
Parameters:
- `id` (required) - ID of specified user
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/approve"
```
Returns:
- `201 OK` on success.
- `404 User Not Found` if user cannot be found.
- `403 Forbidden` if the user cannot be approved because they are blocked by an administrator or by LDAP synchronization.
Example Responses:
```json
{ "message": "Success" }
```
```json
{ "message": "404 User Not Found" }
```
```json
2021-03-11 19:13:27 +05:30
{ "message": "The user you are trying to approve is not pending approval" }
2021-02-22 17:27:13 +05:30
```
2017-08-17 22:00:37 +05:30
## Get an impersonation token of a user
> Requires admin permissions.
It shows a user's impersonation token.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /users/:user_id/impersonation_tokens/:impersonation_token_id
```
Parameters:
2019-09-30 21:07:59 +05:30
| Attribute | Type | Required | Description |
| ------------------------ | ------- | -------- | --------------------------------- |
| `user_id` | integer | yes | The ID of the user |
| `impersonation_token_id` | integer | yes | The ID of the impersonation token |
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens/2"
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"active" : true,
2020-10-24 23:57:45 +05:30
"user_id" : 2,
2017-08-17 22:00:37 +05:30
"scopes" : [
"api"
],
"revoked" : false,
"name" : "mytoken",
"id" : 2,
"created_at" : "2017-03-17T17:18:09.283Z",
"impersonation" : true,
"expires_at" : "2017-04-04"
}
```
## Create an impersonation token
> Requires admin permissions.
2021-02-22 17:27:13 +05:30
> Token values are returned once. Make sure you save it - you can't access it again.
2018-12-05 23:21:45 +05:30
2017-08-17 22:00:37 +05:30
It creates a new impersonation token. Note that only administrators can do this.
You are only able to create impersonation tokens to impersonate the user and perform
2021-02-22 17:27:13 +05:30
both API calls and Git reads and writes. The user can't see these tokens in their profile
2017-08-17 22:00:37 +05:30
settings page.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /users/:user_id/impersonation_tokens
```
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| ------------ | ------- | -------- | --------------------------------------------------------------------------- |
| `user_id` | integer | yes | The ID of the user |
| `name` | string | yes | The name of the impersonation token |
| `expires_at` | date | no | The expiration date of the impersonation token in ISO format (`YYYY-MM-DD`) |
| `scopes` | array | yes | The array of scopes of the impersonation token (`api`, `read_user`) |
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "name=mytoken" --data "expires_at=2017-04-04" --data "scopes[]=api" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens"
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"id" : 2,
"revoked" : false,
2020-10-24 23:57:45 +05:30
"user_id" : 2,
2017-08-17 22:00:37 +05:30
"scopes" : [
"api"
],
"token" : "EsMo-vhKfXGwX9RKrwiy",
"active" : true,
"impersonation" : true,
"name" : "mytoken",
"created_at" : "2017-03-17T17:18:09.283Z",
"expires_at" : "2017-04-04"
}
```
## Revoke an impersonation token
> Requires admin permissions.
It revokes an impersonation token.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id
```
2020-04-08 14:13:33 +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/users/42/impersonation_tokens/1"
2017-08-17 22:00:37 +05:30
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| ------------------------ | ------- | -------- | --------------------------------- |
| `user_id` | integer | yes | The ID of the user |
| `impersonation_token_id` | integer | yes | The ID of the impersonation token |
2017-08-17 22:00:37 +05:30
2021-03-11 19:13:27 +05:30
## Create a personal access token **(FREE SELF)**
2021-01-29 00:20:46 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17176) in GitLab 13.6.
2021-03-08 18:12:59 +05:30
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/267553) in GitLab 13.8.
2021-01-29 00:20:46 +05:30
2021-03-08 18:12:59 +05:30
Use this API to create a new personal access token. Token values are returned once so,
make sure you save it as you can't access it again. This API can only be used by
GitLab administrators.
2021-01-29 00:20:46 +05:30
```plaintext
POST /users/:user_id/personal_access_tokens
```
| Attribute | Type | Required | Description |
| ------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `user_id` | integer | yes | The ID of the user |
| `name` | string | yes | The name of the personal access token |
| `expires_at` | date | no | The expiration date of the personal access token in ISO format (`YYYY-MM-DD`) |
| `scopes` | array | yes | The array of scopes of the personal access token (`api`, `read_user`, `read_api`, `read_repository`, `write_repository`) |
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "name=mytoken" --data "expires_at=2017-04-04" --data "scopes[]=api" "https://gitlab.example.com/api/v4/users/42/personal_access_tokens"
```
Example response:
```json
{
"id": 3,
"name": "mytoken",
"revoked": false,
"created_at": "2020-10-14T11:58:53.526Z",
"scopes": [
"api"
],
"user_id": 42,
"active": true,
"expires_at": "2020-12-31",
"token": "ggbfKkC4n-Lujy8jwCR2"
}
```
## Get user activities (admin only)
2017-08-17 22:00:37 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2020-07-28 23:09:34 +05:30
This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.
2017-08-17 22:00:37 +05:30
Get the last activity date for all users, sorted from oldest to newest.
The activities that update the timestamp are:
2019-09-30 21:07:59 +05:30
- Git HTTP/SSH activities (such as clone, push)
2020-06-23 00:09:42 +05:30
- User logging in to GitLab
- User visiting pages related to Dashboards, Projects, Issues, and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/54947) in GitLab 11.8)
2020-03-13 15:44:24 +05:30
- User using the API
2020-05-24 23:13:21 +05:30
- User using the GraphQL API
2017-08-17 22:00:37 +05:30
By default, it shows the activity for all users in the last 6 months, but this can be
amended by using the `from` parameter.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /user/activities
```
Parameters:
2020-06-23 00:09:42 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ---------------------------------------------------------------------------------------------- |
| `from` | string | no | Date string in the format YEAR-MONTH-DAY. For example, `2016-03-11`. Defaults to 6 months ago. |
2017-08-17 22:00:37 +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/user/activities"
2017-08-17 22:00:37 +05:30
```
Example response:
```json
[
{
"username": "user1",
"last_activity_on": "2015-12-14",
"last_activity_at": "2015-12-14"
},
{
"username": "user2",
"last_activity_on": "2015-12-15",
"last_activity_at": "2015-12-15"
},
{
"username": "user3",
"last_activity_on": "2015-12-16",
"last_activity_at": "2015-12-16"
}
]
```
Please note that `last_activity_at` is deprecated, please use `last_activity_on`.
2020-03-13 15:44:24 +05:30
## User memberships (admin only)
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20532) in GitLab 12.8.
2020-03-13 15:44:24 +05:30
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.
2020-04-08 14:13:33 +05:30
Source can be of type `Namespace` (representing a group) or `Project`. The response represents only direct memberships. Inherited memberships, for example in subgroups, are not included.
Access levels are represented by an integer value. For more details, read about the meaning of [access level values](access_requests.md#valid-access-levels).
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2020-03-13 15:44:24 +05:30
GET /users/:id/memberships
```
Parameters:
2020-06-23 00:09:42 +05:30
| 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` |
2020-03-13 15:44:24 +05:30
Returns:
- `200 OK` on success.
2020-04-08 14:13:33 +05:30
- `404 User Not Found` if user can't be found.
2020-03-13 15:44:24 +05:30
- `403 Forbidden` when not requested by an admin.
- `400 Bad Request` when requested type is not supported.
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/:user_id/memberships"
2020-03-13 15:44:24 +05:30
```
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"
},
]
```