{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account User Search API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "User Search", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Find Users Assignable To Projects", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/assignable/multiProjectSearch", "params": [ { "name": "query", "value": "", "type": "query", "description": "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." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified." }, { "name": "projectKeys", "value": "", "type": "query", "description": "A list of project keys (case sensitive). This parameter accepts a comma-separated list." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

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 can be assigned issues in the projects. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who can be assigned issues in the proje" }, { "info": { "name": "Atlassian Find Users Assignable To Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/assignable/search", "params": [ { "name": "query", "value": "", "type": "query", "description": "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 `username` or `accountId` is specified." }, { "name": "sessionId", "value": "", "type": "query", "description": "The sessionId of this request. SessionId is the same until the assignee is set." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified." }, { "name": "project", "value": "", "type": "query", "description": "The project ID or project key (case sensitive). Required, unless `issueKey` is specified." }, { "name": "issueKey", "value": "", "type": "query", "description": "The key of the issue. Required, unless `project` is specified." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue." }, { "name": "actionDescriptorId", "value": "", "type": "query", "description": "The ID of the transition." }, { "name": "recommend", "value": "", "type": "query" } ] }, "docs": "Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

* a new issue, by providing the `projectKeyOrId`.
* an updated issue, by providing the `issueKey`.
* to an issue during a transition (workflow action), by providing the `issueKey` and the transition id in `actionDescriptorId`. You can obtain the IDs of an issue's valid transitions using the `transitions` option in the `expand` parameter of [ Get issue]" }, { "info": { "name": "Atlassian Find Users With Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/permission/search", "params": [ { "name": "query", "value": "", "type": "query", "description": "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." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified." }, { "name": "permissions", "value": "", "type": "query", "description": "A comma separated list of permissions. Permissions can be specified as any:\n\n * permission returned by [Get all permissions](#api-rest-api-3-permissions-get).\n * custom project permission added by Connect apps.\n * (deprecated) one of the following:\n \n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE" }, { "name": "issueKey", "value": "", "type": "query", "description": "The issue key for the issue." }, { "name": "projectKey", "value": "", "type": "query", "description": "The project key for the project (case sensitive)." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "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 iss" }, { "info": { "name": "Atlassian Find Users For Picker", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/picker", "params": [ { "name": "query", "value": "", "type": "query", "description": "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*." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return. The total number of matched users is returned in `total`." }, { "name": "showAvatar", "value": "", "type": "query", "description": "Include the URI to the user's avatar." }, { "name": "exclude", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "excludeAccountIds", "value": "", "type": "query", "description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`." }, { "name": "avatarSize", "value": "", "type": "query" }, { "name": "excludeConnectUsers", "value": "", "type": "query" } ] }, "docs": "Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

This operation takes the users in the range defined by `maxResults`, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in" }, { "info": { "name": "Atlassian Find Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/search", "params": [ { "name": "query", "value": "", "type": "query", "description": "A query string that is matched against user attributes ( `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` or `property` is specified." }, { "name": "username", "value": "", "type": "query" }, { "name": "accountId", "value": "", "type": "query", "description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of filtered results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "property", "value": "", "type": "query", "description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified." } ] }, "docs": "Returns a list of active users that match the search string and property.

This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by `startAt` and `maxResults`, up to the thousandth user. To get all the users who match the search string and property, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.

This operation can be accessed anonymously.

Privacy control" }, { "info": { "name": "Atlassian Find Users By Query", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/search/query", "params": [ { "name": "query", "value": "", "type": "query", "description": "The search query." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Finds users with a structured query and returns a [paginated](#pagination) list of user details.

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 structured query. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter th" }, { "info": { "name": "Atlassian Find User Keys By Query", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/search/query/key", "params": [ { "name": "query", "value": "", "type": "query", "description": "The search query." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResult", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Finds users with a structured query and returns a [paginated](#pagination) list of user keys.

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 structured query. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter the r" }, { "info": { "name": "Atlassian Find Users With Browse Permission", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/viewissue/search", "params": [ { "name": "query", "value": "", "type": "query", "description": "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." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified." }, { "name": "issueKey", "value": "", "type": "query", "description": "The issue key for the issue. Required, unless `projectKey` is specified." }, { "name": "projectKey", "value": "", "type": "query", "description": "The project key for the project (case sensitive). Required, unless `issueKey` is specified." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "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" } ] } ], "bundled": true }