Atlassian: Find users and groups

Atlassian groupAndUserPicker.findUsersAndGroups: arguments, response, policy and SDK examples.

← Group and user picker operations · Get started

Operation atlassian.findusersandgroups

Provider route: GET /{cloudId}/rest/api/3/groupuserpicker. 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["groupAndUserPicker"]["findUsersAndGroups"]>[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.groupAndUserPicker.findUsersAndGroups(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.group_and_user_picker.find_users_and_groups(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.fieldId`	string	Optional
`query.projectId`	array	Optional
`query.projectId[]`	string	Each item
`query.issueTypeId`	array	Optional
`query.issueTypeId[]`	string	Each item
`query.avatarSize`	string	Optional	Default: xsmall One of: xsmall, xsmall@2x, xsmall@3x, small, small@2x, small@3x, medium, medium@2x, medium@3x, large, large@2x, large@3x, xlarge, xlarge@2x, xlarge@3x, xxlarge, xxlarge@2x, xxlarge@3x, xxxlarge, xxxlarge@2x, xxxlarge@3x
`query.caseInsensitive`	boolean	Optional	Default: false
`query.excludeConnectAddons`	boolean	Optional	Default: false
`query.includeAiAgents`	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 and groups — response body

Referenced models: Find users and groups — response body

Schemas

Find users and groups — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of users and groups found in a search.
`groups`	JSON	Optional
`groups (anyOf 1)`	Model	Alternative	Expand Find groups — response body
`groups (anyOf 2)`	null	Alternative
`users`	JSON	Optional
`users (anyOf 1)`	Model	Alternative	Expand Find users for picker — response body
`users (anyOf 2)`	null	Alternative

Referenced models: Find groups — response body, Find users for picker — response body

Find groups — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.
`groups`	JSON	Optional
`groups (anyOf 1)`	array	Alternative
`groups (anyOf 1)[]`	Model	Each item	Expand Find groups — response body — groups array item
`groups (anyOf 2)`	null	Alternative
`header`	JSON	Optional
`header (anyOf 1)`	string	Alternative	Header text indicating the number of groups in the response and the total number of groups 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 groups 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

Referenced models: Find groups — response body — groups array item

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 groups — response body — groups array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A group found in a search.
`avatarUrl`	JSON	Optional
`avatarUrl (anyOf 1)`	string	Alternative	Avatar url for the group/team if present.
`avatarUrl (anyOf 2)`	null	Alternative
`groupId`	JSON	Optional
`groupId (anyOf 1)`	string	Alternative	The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.
`groupId (anyOf 2)`	null	Alternative
`html`	JSON	Optional
`html (anyOf 1)`	string	Alternative	The group name with the matched query string highlighted with the HTML bold tag.
`html (anyOf 2)`	null	Alternative
`labels`	JSON	Optional
`labels (anyOf 1)`	array	Alternative
`labels (anyOf 1)[]`	Model	Each item	Expand Find groups — response body — groups array item labels array item
`labels (anyOf 2)`	null	Alternative
`managedBy`	JSON	Optional
`managedBy (anyOf 1)`	string	Alternative	Describes who/how the team is managed. The possible values are \* external - when team is synced from an external directory like SCIM or HRIS, and team members cannot be modified. \* admins - when a team is managed by an admin (team members can only be modified by admins). \* team-members - managed by existing team members, new members need to be invited to join. \* open - anyone can join or modify this team. Known values: EXTERNAL, ADMINS, TEAM_MEMBERS, OPEN
`managedBy (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId`.`
`name (anyOf 2)`	null	Alternative
`usageType`	JSON	Optional
`usageType (anyOf 1)`	string	Alternative	Describes the type of group. The possible values are \* team-collaboration - A platform team managed in people directory. \* userbase-group - a group of users created in adminhub. \* admin-oversight - currently unused. Known values: USERBASE_GROUP, TEAM_COLLABORATION, ADMIN_OVERSIGHT
`usageType (anyOf 2)`	null	Alternative

Referenced models: Find groups — response body — groups array item labels 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

Find groups — response body — groups array item labels array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A group label.
`text`	JSON	Optional
`text (anyOf 1)`	string	Alternative	The group label name.
`text (anyOf 2)`	null	Alternative
`title`	JSON	Optional
`title (anyOf 1)`	string	Alternative	The title of the group label.
`title (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of the group label. Known values: ADMIN, SINGLE, MULTIPLE
`type (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.findusersandgroups. Catalog operation: findusersandgroups. 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-work"]

Official provider source

Report an issue with this page