GET /rest/api/2/user/permission/search

Returns a list of users who fulfill these criteria:

their user attributes match a search string.
they have a set of permissions for a project or issue.

If no search string is provided, a list of all users with the permissions is returned.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use Get all users and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

This operation can be accessed anonymously.

Permissions required:

Administer Jira global permission, to get users for any project.
Administer Projects project permission for a project, to get users for that project.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`startAt`	Integer	No	The index of the first item to return in a page of results (page offset). Default value: 0
`query`	String	No	A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a `displayName` of John Smith and a user with an `emailAddress` of johnson@example.com. Required, unless `accountId` is specified.
`username`	String	No	This parameter is no longer available. See the deprecation notice for details.
`maxResults`	Integer	No	The maximum number of items to return per page. Default value: 50
`accountId`	String	No	A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.
`permissions`	String	Yes	A comma separated list of permissions. Permissions can be specified as any: permission returned by Get all permissions. custom project permission added by Connect apps. (deprecated) one of the following: ASSIGNABLE_USER ASSIGN_ISSUE ATTACHMENT_DELETE_ALL ATTACHMENT_DELETE_OWN BROWSE CLOSE_ISSUE COMMENT_DELETE_ALL COMMENT_DELETE_OWN COMMENT_EDIT_ALL COMMENT_EDIT_OWN COMMENT_ISSUE CREATE_ATTACHMENT CREATE_ISSUE DELETE_ISSUE EDIT_ISSUE LINK_ISSUE MANAGE_WATCHER_LIST MODIFY_REPORTER MOVE_ISSUE PROJECT_ADMIN RESOLVE_ISSUE SCHEDULE_ISSUE SET_ISSUE_SECURITY TRANSITION_ISSUE VIEW_VERSION_CONTROL VIEW_VOTERS_AND_WATCHERS VIEW_WORKFLOW_READONLY WORKLOG_DELETE_ALL WORKLOG_DELETE_OWN WORKLOG_EDIT_ALL WORKLOG_EDIT_OWN WORK_ISSUE
`issueKey`	String	No	The issue key for the issue.
`projectKey`	String	No	The project key for the project (case sensitive).

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.