Skip to content

Commit ebc265c

Browse files
author
Robert-John van Doesburg
committed
Update docs for UserRequest get all users
1 parent db53809 commit ebc265c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/UserRequest.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,41 @@ _Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3#api-
5959
## Get user groups
6060
_Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3#api-api-3-user-groups-get_
6161

62+
## Get all users
63+
64+
`GET /rest/api/3/users/search`
65+
66+
Returns a list of all (active and inactive) users.
67+
68+
**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse users and groups_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
69+
70+
**OAuth scopes required:** `read:jira-user`
71+
72+
_Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-users-search-get_
73+
74+
### Request
75+
76+
Query parameters
77+
78+
| Name | Type | Description | |
79+
|------------|---------|----------------------------------------|-----------------------------------|
80+
| startAt | Integer | The index of the first item to return. | Default: `0`,<br>Format:`int32` |
81+
| maxResults | Integer | The maximum number of items to return. | Default: `50`,<br>Format: `int32` |
82+
83+
### Example
84+
85+
```php
86+
<?php
87+
use Atlassian\JiraRest\Requests;
88+
89+
/** @var \Atlassian\JiraRest\Requests\ServerInfoRequest $request */
90+
$request = app(Requests\User\UserRequest::class);
91+
92+
$response = $request->searchAll();
93+
94+
$output = \json_decode($response->getBody()->getContents(), true);
95+
```
96+
6297
## Find users with permissions
6398
_Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3#api-api-3-user-permission-search-get_
6499

0 commit comments

Comments
 (0)