Find Users With Browse Permission
GET {{baseUrl}}/rest/api/3/user/viewissue/search?query=<string>&username=<string>&accountId=<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 permission to browse issues.
Use this resource to find users who can browse:
- an issue, by providing the
issueKey. - any issue in a project, by providing the
projectKey.
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 to browse issues. 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 to browse issues, use Get all users and filter the records in your code.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.
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. | |
issueKey | string | The issue key for the issue. Required, unless projectKey is specified. | |
projectKey | string | The project key for the project (case sensitive). Required, unless issueKey is specified. | |
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}]