File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff 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
You can’t perform that action at this time.
0 commit comments