users.md 31 KB
Newer Older
1
# Users API
Marin Jankovski's avatar
Marin Jankovski committed
2

Nihad Abbasov's avatar
Nihad Abbasov committed
3 4 5
## List users

Get a list of users.
6

7
This function takes pagination parameters `page` and `per_page` to restrict the list of users.
Nihad Abbasov's avatar
Nihad Abbasov committed
8

Ciro Santilli's avatar
Ciro Santilli committed
9
### For normal users
10 11 12 13 14 15 16 17 18 19 20 21 22

```
GET /users
```

```json
[
  {
    "id": 1,
    "username": "john_smith",
    "name": "John Smith",
    "state": "active",
    "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
23
    "web_url": "http://localhost:3000/john_smith"
24 25 26 27 28 29 30
  },
  {
    "id": 2,
    "username": "jack_smith",
    "name": "Jack Smith",
    "state": "blocked",
    "avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
31
    "web_url": "http://localhost:3000/jack_smith"
32 33 34 35
  }
]
```

36 37 38 39 40 41 42 43 44 45 46 47
In addition, you can filter users based on states eg. `blocked`, `active`
This works only to filter users who are `blocked` or `active`.
It does not support `active=false` or `blocked=false`.

```
GET /users?active=true
```

```
GET /users?blocked=true
```

Ciro Santilli's avatar
Ciro Santilli committed
48
### For admins
49

Nihad Abbasov's avatar
Nihad Abbasov committed
50 51 52 53 54 55 56 57
```
GET /users
```

```json
[
  {
    "id": 1,
58
    "username": "john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
59 60
    "email": "john@example.com",
    "name": "John Smith",
61
    "state": "active",
62
    "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
63
    "web_url": "http://localhost:3000/john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
64
    "created_at": "2012-05-23T08:00:58Z",
65
    "is_admin": false,
Nihad Abbasov's avatar
Nihad Abbasov committed
66
    "bio": null,
67
    "location": null,
Nihad Abbasov's avatar
Nihad Abbasov committed
68 69 70
    "skype": "",
    "linkedin": "",
    "twitter": "",
Jerome Dalbert's avatar
Jerome Dalbert committed
71
    "website_url": "",
72
    "organization": "",
73 74
    "last_sign_in_at": "2012-06-01T11:41:01Z",
    "confirmed_at": "2012-05-23T09:05:22Z",
75
    "theme_id": 1,
76
    "last_activity_on": "2012-05-23",
77
    "color_scheme_id": 2,
78 79 80 81 82 83 84
    "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"}
    ],
85
    "can_create_group": true,
86 87 88
    "can_create_project": true,
    "two_factor_enabled": true,
    "external": false
Nihad Abbasov's avatar
Nihad Abbasov committed
89 90 91
  },
  {
    "id": 2,
92
    "username": "jack_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
93 94
    "email": "jack@example.com",
    "name": "Jack Smith",
95
    "state": "blocked",
96
    "avatar_url": "http://localhost:3000/uploads/user/avatar/2/index.jpg",
97
    "web_url": "http://localhost:3000/jack_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
98
    "created_at": "2012-05-23T08:01:01Z",
99
    "is_admin": false,
Nihad Abbasov's avatar
Nihad Abbasov committed
100
    "bio": null,
101
    "location": null,
Nihad Abbasov's avatar
Nihad Abbasov committed
102 103 104
    "skype": "",
    "linkedin": "",
    "twitter": "",
Jerome Dalbert's avatar
Jerome Dalbert committed
105
    "website_url": "",
106
    "organization": "",
107 108
    "last_sign_in_at": null,
    "confirmed_at": "2012-05-30T16:53:06.148Z",
109
    "theme_id": 1,
110
    "last_activity_on": "2012-05-23",
111
    "color_scheme_id": 3,
112
    "projects_limit": 100,
Stan Hu's avatar
Stan Hu committed
113
    "current_sign_in_at": "2014-03-19T17:54:13Z",
114 115 116 117 118
    "identities": [],
    "can_create_group": true,
    "can_create_project": true,
    "two_factor_enabled": true,
    "external": false
Nihad Abbasov's avatar
Nihad Abbasov committed
119 120 121 122
  }
]
```

Ciro Santilli's avatar
Typo.  
Ciro Santilli committed
123
You can search for users by email or username with: `/users?search=John`
dosire's avatar
dosire committed
124

125 126 127 128 129 130 131 132 133 134 135
In addition, you can lookup users by username:

```
GET /users?username=:username
```

For example:

```
GET /users?username=jack_smith
```
136

137 138 139 140 141 142 143 144 145 146 147 148
You can also lookup users by external UID and provider:

```
GET /users?extern_uid=:extern_uid&provider=:provider
```

For example:

```
GET /users?extern_uid=1234567&provider=github
```

149 150
You can search for users who are external with: `/users?external=true`

151 152 153 154 155 156
You can search users by creation date time range with:

```
GET /users?created_before=2001-01-02T00:00:00.060Z&created_after=1999-01-02T00:00:00.060
```

Nihad Abbasov's avatar
Nihad Abbasov committed
157 158 159 160
## Single user

Get a single user.

Ciro Santilli's avatar
Ciro Santilli committed
161
### For user
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

```
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",
178
  "web_url": "http://localhost:3000/john_smith",
179 180
  "created_at": "2012-05-23T08:00:58Z",
  "bio": null,
181
  "location": null,
182 183 184
  "skype": "",
  "linkedin": "",
  "twitter": "",
185 186
  "website_url": "",
  "organization": ""
187 188 189
}
```

Ciro Santilli's avatar
Ciro Santilli committed
190
### For admin
191

Nihad Abbasov's avatar
Nihad Abbasov committed
192 193 194 195 196 197
```
GET /users/:id
```

Parameters:

198
- `id` (required) - The ID of a user
Nihad Abbasov's avatar
Nihad Abbasov committed
199 200 201 202

```json
{
  "id": 1,
203
  "username": "john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
204 205
  "email": "john@example.com",
  "name": "John Smith",
206
  "state": "active",
207
  "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
208
  "web_url": "http://localhost:3000/john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
209
  "created_at": "2012-05-23T08:00:58Z",
210
  "is_admin": false,
Nihad Abbasov's avatar
Nihad Abbasov committed
211
  "bio": null,
212
  "location": null,
Nihad Abbasov's avatar
Nihad Abbasov committed
213 214 215
  "skype": "",
  "linkedin": "",
  "twitter": "",
Jerome Dalbert's avatar
Jerome Dalbert committed
216
  "website_url": "",
217
  "organization": "",
218 219
  "last_sign_in_at": "2012-06-01T11:41:01Z",
  "confirmed_at": "2012-05-23T09:05:22Z",
220
  "theme_id": 1,
221
  "last_activity_on": "2012-05-23",
222
  "color_scheme_id": 2,
223 224 225 226 227 228 229
  "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"}
  ],
230
  "can_create_group": true,
231
  "can_create_project": true,
232 233
  "two_factor_enabled": true,
  "external": false
Nihad Abbasov's avatar
Nihad Abbasov committed
234 235 236
}
```

237
## User creation
238

239
Creates a new user. Note only administrators can create new users. Either `password` or `reset_password` should be specified (`reset_password` takes priority).
240 241 242 243 244 245 246

```
POST /users
```

Parameters:

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
- `email` (required)             - Email
- `password` (optional)          - Password
- `reset_password` (optional)    - Send user password reset link - true or false(default)
- `username` (required)          - Username
- `name` (required)              - Name
- `skype` (optional)             - Skype ID
- `linkedin` (optional)          - LinkedIn
- `twitter` (optional)           - Twitter account
- `website_url` (optional)       - Website URL
- `organization` (optional)      - Organization name
- `projects_limit` (optional)    - Number of projects user can create
- `extern_uid` (optional)        - External UID
- `provider` (optional)          - External provider name
- `bio` (optional)               - User's biography
- `location` (optional)          - User's location
- `admin` (optional)             - User is admin - true or false (default)
- `can_create_group` (optional)  - User can create groups - true or false
- `skip_confirmation` (optional) - Skip confirmation - true or false (default)
- `external` (optional)          - Flags the user as external - true or false(default)
- `avatar` (optional)            - Image file for user's avatar
267

268
## User modification
269 270

Modifies an existing user. Only administrators can change attributes of a user.
271 272 273 274 275 276

```
PUT /users/:id
```

Parameters:
277

Ciro Santilli's avatar
Ciro Santilli committed
278 279 280 281 282 283 284 285
- `email`                       - Email
- `username`                    - Username
- `name`                        - Name
- `password`                    - Password
- `skype`                       - Skype ID
- `linkedin`                    - LinkedIn
- `twitter`                     - Twitter account
- `website_url`                 - Website URL
286
- `organization`                - Organization name
Ciro Santilli's avatar
Ciro Santilli committed
287 288 289 290
- `projects_limit`              - Limit projects each user can create
- `extern_uid`                  - External UID
- `provider`                    - External provider name
- `bio`                         - User's biography
291
- `location` (optional)         - User's location
Ciro Santilli's avatar
Ciro Santilli committed
292 293
- `admin` (optional)            - User is admin - true or false (default)
- `can_create_group` (optional) - User can create groups - true or false
294
- `external` (optional)         - Flags the user as external - true or false(default)
295
- `avatar` (optional)           - Image file for user's avatar
Ciro Santilli's avatar
Ciro Santilli committed
296

297
On password update, user will be forced to change it upon next login.
298 299
Note, at the moment this method does only return a `404` error,
even in cases where a `409` (Conflict) would be more appropriate,
Ciro Santilli's avatar
Ciro Santilli committed
300
e.g. when renaming the email address to some existing one.
301 302

## User deletion
303

Ciro Santilli's avatar
Ciro Santilli committed
304
Deletes a user. Available only for administrators.
305
This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
306 307 308 309 310

```
DELETE /users/:id
```

311 312
Parameters:

313
- `id` (required) - The ID of the user
314 315 316
- `hard_delete` (optional) - If true, contributions that would usually be
  [moved to the ghost user](../user/profile/account/delete_account.md#associated-records)
  will be deleted instead, as well as groups owned solely by this user.
317

318 319 320
## User

### For normal users
Nihad Abbasov's avatar
Nihad Abbasov committed
321

322
Gets currently authenticated user.
Nihad Abbasov's avatar
Nihad Abbasov committed
323 324 325 326 327 328 329 330

```
GET /user
```

```json
{
  "id": 1,
331
  "username": "john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
332 333
  "email": "john@example.com",
  "name": "John Smith",
334
  "state": "active",
335
  "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
336
  "web_url": "http://localhost:3000/john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
337 338
  "created_at": "2012-05-23T08:00:58Z",
  "bio": null,
339
  "location": null,
Nihad Abbasov's avatar
Nihad Abbasov committed
340 341 342
  "skype": "",
  "linkedin": "",
  "twitter": "",
Jerome Dalbert's avatar
Jerome Dalbert committed
343
  "website_url": "",
344
  "organization": "",
345 346
  "last_sign_in_at": "2012-06-01T11:41:01Z",
  "confirmed_at": "2012-05-23T09:05:22Z",
347
  "theme_id": 1,
348
  "last_activity_on": "2012-05-23",
349
  "color_scheme_id": 2,
350 351 352 353 354 355 356
  "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"}
  ],
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
357
  "can_create_group": true,
358
  "can_create_project": true,
359
  "two_factor_enabled": true,
360
  "external": false
Nihad Abbasov's avatar
Nihad Abbasov committed
361 362
}
```
363

364 365 366 367
### For admins

Parameters:

368
- `sudo` (optional) - the ID of a user to make the call in their place
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

```
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,
  "bio": null,
  "location": null,
  "skype": "",
  "linkedin": "",
  "twitter": "",
  "website_url": "",
  "organization": "",
  "last_sign_in_at": "2012-06-01T11:41:01Z",
  "confirmed_at": "2012-05-23T09:05:22Z",
394
  "theme_id": 1,
395
  "last_activity_on": "2012-05-23",
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
  "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,
  "external": false,
  "private_token": "dd34asd13as"
}
```

412 413 414 415 416 417 418 419 420 421 422 423
## List SSH keys

Get a list of currently authenticated user's SSH keys.

```
GET /user/keys
```

```json
[
  {
    "id": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
424
    "title": "Public key",
425 426
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
    "created_at": "2014-08-01T14:47:39.080Z"
427 428 429
  },
  {
    "id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
430
    "title": "Another Public key",
431 432
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
    "created_at": "2014-08-01T14:47:39.080Z"
433 434 435 436
  }
]
```

437 438
Parameters:

439
- **none**
440

441 442 443 444 445
## List SSH keys for user

Get a list of a specified user's SSH keys. Available only for admin

```
Robert Schilling's avatar
Robert Schilling committed
446
GET /users/:id/keys
447 448 449 450
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
451
- `id` (required) - id of specified user
452

453 454 455 456 457
## Single SSH key

Get a single key.

```
Robert Schilling's avatar
Robert Schilling committed
458
GET /user/keys/:key_id
459 460 461 462
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
463
- `key_id` (required) - The ID of an SSH key
464 465 466 467

```json
{
  "id": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
468
  "title": "Public key",
469 470
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
  "created_at": "2014-08-01T14:47:39.080Z"
471 472
}
```
473

474 475
## Add SSH key

476
Creates a new key owned by the currently authenticated user.
477 478 479 480 481 482 483

```
POST /user/keys
```

Parameters:

484
- `title` (required) - new SSH Key's title
Ciro Santilli's avatar
Ciro Santilli committed
485
- `key` (required)   - new SSH key
486

487 488 489 490 491 492 493 494 495
```json
{
  "created_at": "2015-01-21T17:44:33.512Z",
  "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",
  "title": "ABC",
  "id": 4
}
```

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
Will return created key with status `201 Created` on success. If an
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"
    ]
  }
}
```

512 513 514 515 516 517 518 519 520 521
## Add SSH key for user

Create new key owned by specified user. Available only for admin

```
POST /users/:id/keys
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
522
- `id` (required)    - id of specified user
523
- `title` (required) - new SSH Key's title
Ciro Santilli's avatar
Ciro Santilli committed
524
- `key` (required)   - new SSH key
525

526
## Delete SSH key for current user
527

Ciro Santilli's avatar
Ciro Santilli committed
528
Deletes key owned by currently authenticated user.
529
This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
530 531

```
Robert Schilling's avatar
Robert Schilling committed
532
DELETE /user/keys/:key_id
533 534 535 536
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
537
- `key_id` (required) - SSH key ID
538

539
## Delete SSH key for given user
540 541 542 543

Deletes key owned by a specified user. Available only for admin.

```
Robert Schilling's avatar
Robert Schilling committed
544
DELETE /users/:id/keys/:key_id
545 546 547 548
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
549 550
- `id` (required) - id of specified user
- `key_id` (required)  - SSH key ID
551

Robert Schilling's avatar
Robert Schilling committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
## List all GPG keys

Get a list of currently authenticated user's GPG keys.

```
GET /user/gpg_keys
```

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/user/gpg_keys
```

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.

```
GET /user/gpg_keys/:key_id
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `key_id`  | integer | yes   | The ID of the GPG key |

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/user/gpg_keys/1
```

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.

```
POST /user/gpg_keys
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| key       | string | yes    | The new GPG key |

```bash
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..."  --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/user/gpg_keys
```

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.

```
DELETE /user/gpg_keys/:key_id
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `key_id`  | integer | yes   | The ID of the GPG key |

```bash
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/user/gpg_keys/1
```

Returns `204 No Content` on success, or `404 Not found` if the key cannot be found.

## List all GPG keys for given user

Get a list of a specified user's GPG keys. Available only for admins.

```
GET /users/:id/gpg_keys
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of the user |

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/2/gpg_keys
```

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

Get a specific GPG key for a given user. Available only for admins.

```
GET /users/:id/gpg_keys/:key_id
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of the user |
| `key_id`  | integer | yes   | The ID of the GPG key |

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/2/gpg_keys/1
```

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.

```
POST /users/:id/gpg_keys
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of the user |
| `key_id`  | integer | yes   | The ID of the GPG key |

```bash
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..."  --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/2/gpg_keys
```

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.

```
DELETE /users/:id/gpg_keys/:key_id
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of the user |
| `key_id`  | integer | yes   | The ID of the GPG key |

```bash
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/2/gpg_keys/1
```

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
## List emails

Get a list of currently authenticated user's emails.

```
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

```
Robert Schilling's avatar
Robert Schilling committed
793
GET /users/:id/emails
794 795 796 797
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
798
- `id` (required) - id of specified user
799

Douwe Maan's avatar
Douwe Maan committed
800
## Single email
801

Douwe Maan's avatar
Douwe Maan committed
802
Get a single email.
803 804

```
Robert Schilling's avatar
Robert Schilling committed
805
GET /user/emails/:email_id
806 807 808 809
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
810
- `email_id` (required) - email ID
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837

```json
{
  "id": 1,
  "email": "email@example.com"
}
```

## Add email

Creates a new email owned by the currently authenticated user.

```
POST /user/emails
```

Parameters:

- `email` (required) - email address

```json
{
  "id": 4,
  "email": "email@example.com"
}
```

Douwe Maan's avatar
Douwe Maan committed
838
Will return created email with status `201 Created` on success. If an
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
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

```
POST /users/:id/emails
```

Parameters:

- `id` (required)    - id of specified user
- `email` (required) - email address

## Delete email for current user

Deletes email owned by currently authenticated user.
867
This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
868 869

```
Robert Schilling's avatar
Robert Schilling committed
870
DELETE /user/emails/:email_id
871 872 873 874
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
875
- `email_id` (required) - email ID
876 877 878 879 880 881

## Delete email for given user

Deletes email owned by a specified user. Available only for admin.

```
Robert Schilling's avatar
Robert Schilling committed
882
DELETE /users/:id/emails/:email_id
883 884 885 886
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
887 888
- `id` (required) - id of specified user
- `email_id` (required)  - email ID
889

890 891 892 893 894
## Block user

Blocks the specified user.  Available only for admin.

```
895
POST /users/:id/block
896 897 898 899
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
900
- `id` (required) - id of specified user
901

902
Will return `201 OK` on success, `404 User Not Found` is user cannot be found or
903
`403 Forbidden` when trying to block an already blocked user by LDAP synchronization.
904 905 906 907 908 909

## Unblock user

Unblocks the specified user.  Available only for admin.

```
910
POST /users/:id/unblock
911 912 913 914
```

Parameters:

Robert Schilling's avatar
Robert Schilling committed
915
- `id` (required) - id of specified user
916

917
Will return `201 OK` on success, `404 User Not Found` is user cannot be found or
918
`403 Forbidden` when trying to unblock a user blocked by LDAP synchronization.
919 920 921

### Get user contribution events

Mark Fletcher's avatar
Mark Fletcher committed
922
Please refer to the [Events API documentation](events.md#get-user-contribution-events)
923

924

925
## Get all impersonation tokens of a user
926

927 928 929 930
> 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.
931 932

```
933
GET /users/:user_id/impersonation_tokens
934 935 936 937 938 939
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
940
| `user_id` | integer | yes | The ID of the user |
941 942 943 944 945
| `state`   | string  | no | filter tokens based on state (`all`, `active`, `inactive`) |

```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/impersonation_tokens
```
946

947
Example response:
948

949 950
```json
[
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
   {
      "active" : true,
      "token" : "EsMo-vhKfXGwX9RKrwiy",
      "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,
      "scopes" : [
         "read_user"
      ],
      "revoked" : true,
      "token" : "ZcZRpLeEuQRprkRjYydY",
      "name" : "mytoken2",
      "created_at" : "2017-03-17T17:19:28.697Z",
      "id" : 3,
      "impersonation" : true,
      "expires_at" : "2017-04-14"
   }
977 978 979
]
```

980
## Get an impersonation token of a user
981

982 983 984
> Requires admin permissions.

It shows a user's impersonation token.
985 986

```
987
GET /users/:user_id/impersonation_tokens/:impersonation_token_id
988 989 990 991 992 993
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
994 995
| `user_id` | integer | yes | The ID of the user |
| `impersonation_token_id` | integer | yes | The ID of the impersonation token |
996

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/impersonation_tokens/2
```

Example response:

```json
{
   "active" : true,
   "token" : "EsMo-vhKfXGwX9RKrwiy",
   "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.
1022

1023
It creates a new impersonation token. Note that only administrators can do this.
1024
You are only able to create impersonation tokens to impersonate the user and perform
1025
both API calls and Git reads and writes. The user will not see these tokens in their profile
1026
settings page.
1027 1028

```
1029
POST /users/:user_id/impersonation_tokens
1030 1031 1032 1033 1034 1035
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
1036
| `user_id` | integer | yes | The ID of the user |
1037 1038 1039 1040 1041 1042 1043
| `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`) |

```
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "name=mytoken" --data "expires_at=2017-04-04" --data "scopes[]=api" https://gitlab.example.com/api/v4/users/42/impersonation_tokens
```
1044

1045
Example response:
1046

1047 1048
```json
{
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
   "id" : 2,
   "revoked" : false,
   "scopes" : [
      "api"
   ],
   "token" : "EsMo-vhKfXGwX9RKrwiy",
   "active" : true,
   "impersonation" : true,
   "name" : "mytoken",
   "created_at" : "2017-03-17T17:18:09.283Z",
   "expires_at" : "2017-04-04"
1060 1061
}
```
1062

1063 1064
## Revoke an impersonation token

1065 1066 1067
> Requires admin permissions.

It revokes an impersonation token.
1068 1069

```
1070
DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id
1071 1072
```

1073 1074 1075 1076
```
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/impersonation_tokens/1
```

1077 1078 1079 1080
Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
1081 1082
| `user_id` | integer | yes | The ID of the user |
| `impersonation_token_id` | integer | yes | The ID of the impersonation token |
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108

### Get user activities (admin only)

>**Note:** This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.

Get the last activity date for all users, sorted from oldest to newest.

The activities that update the timestamp are:

  - Git HTTP/SSH activities (such as clone, push)
  - User logging in into GitLab

By default, it shows the activity for all users in the last 6 months, but this can be
amended by using the `from` parameter.

```
GET /user/activities
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `from` | string | no | Date string in the format YEAR-MONTH-DAY, e.g. `2016-03-11`. Defaults to 6 months ago. |

```bash
1109
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/user/activities
1110 1111 1112 1113 1114 1115 1116 1117
```

Example response:

```json
[
  {
    "username": "user1",
1118 1119
    "last_activity_on": "2015-12-14",
    "last_activity_at": "2015-12-14"
1120 1121 1122
  },
  {
    "username": "user2",
1123 1124
    "last_activity_on": "2015-12-15",
    "last_activity_at": "2015-12-15"
1125 1126 1127
  },
  {
    "username": "user3",
1128 1129
    "last_activity_on": "2015-12-16",
    "last_activity_at": "2015-12-16"
1130 1131
  }
]
1132 1133 1134
```

Please note that `last_activity_at` is deprecated, please use `last_activity_on`.