Atlassian: Find users for picker

← User search operations · Get started

Operation atlassian.findusersforpicker

Provider route: GET /{cloudId}/rest/api/3/user/picker. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["userSearch"]["findUsersForPicker"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.userSearch.findUsersForPicker(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.user_search.find_users_for_picker(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
query	object	Required within parent	Additional keys: not allowed
query.query	string	Required within parent
query.maxResults	integer	Optional	Default: 50 Format: int32
query.showAvatar	boolean	Optional	Default: false
query.exclude	array	Optional
query.exclude[]	string	Each item
query.excludeAccountIds	array	Optional
query.excludeAccountIds[]	string	Each item
query.avatarSize	string	Optional
query.excludeConnectUsers	boolean	Optional	Default: false

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Find users for picker — response body

Referenced models: Find users for picker — response body

Schemas

Find users for picker — response body

Field	Type	Presence	Description and constraints
$	object	Root	The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.
header	JSON	Optional
header (anyOf 1)	string	Alternative	Header text indicating the number of users in the response and the total number of users found in the search.
header (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The total number of users found in the search. Format: int32
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative
users	JSON	Optional
users (anyOf 1)	array	Alternative
users (anyOf 1)[]	Model	Each item	Expand Find users for picker — response body — users array item
users (anyOf 2)	null	Alternative

Referenced models: Find users for picker — response body — users array item

Find users for picker — response body — users array item

Field	Type	Presence	Description and constraints
$	object	Root	A user found in a search.
accountId	JSON	Optional
accountId (anyOf 1)	string	Alternative	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
accountId (anyOf 2)	null	Alternative
accountType	JSON	Optional
accountType (anyOf 1)	string	Alternative	The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk Known values: atlassian, app, customer, unknown
accountType (anyOf 2)	null	Alternative
avatarUrl	JSON	Optional
avatarUrl (anyOf 1)	string	Alternative	The avatar URL of the user. Format: uri
avatarUrl (anyOf 2)	null	Alternative
displayName	JSON	Optional
displayName (anyOf 1)	string	Alternative	The display name of the user. Depending on the user’s privacy setting, this may be returned as null.
displayName (anyOf 2)	null	Alternative
html	JSON	Optional
html (anyOf 1)	string	Alternative	The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.
html (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	This property is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	This property 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 (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.findusersforpicker. Catalog operation: findusersforpicker. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-user"]

Official provider source