Find Users With Permissions
GET {{baseUrl}}/rest/api/3/user/permission/search?query=<string>&username=<string>&accountId=<string>&permissions=<string>&issueKey=<string>&projectKey=<string>&startAt=0&maxResults=50
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.
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | 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 | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. | |
accountId | string | A query string that is matched exactly against user accountId. Required, unless query is specified. | |
permissions | string | (Required) 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 | | The issue key for the issue. | |projectKey| string | | The project key for the project (case sensitive). | |startAt| number | | The index of the first item to return in a page of results (page offset). | |maxResults| number | | The maximum number of items to return per page. |
RESPONSES
status: OK
[{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32"},"displayName":"Mia Krystof","active":false},{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5","key":"","accountId":"5b10ac8d82e05b22cc7d4ef5","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32\u0026s=32"},"displayName":"Emma Richards","active":false}]