Atlassian: Get account I Ds for users

← Users operations · Get started

Operation atlassian.bulkgetusersmigration

Provider route: GET /{cloudId}/rest/api/3/user/bulk/migration. 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["users"]["bulkGetUsersMigration"]>[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.users.bulkGetUsersMigration(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.users.bulk_get_users_migration(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	Optional	Additional keys: not allowed
query.startAt	integer	Optional	Default: 0 Format: int64
query.maxResults	integer	Optional	Default: 10 Format: int32
query.username	array	Optional
query.username[]	string	Each item
query.key	array	Optional
query.key[]	string	Each item

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
$	array	Root
$[]	Model	Each item	Expand Get account I Ds for users — response body — item

Referenced models: Get account I Ds for users — response body — item

Schemas

Get account I Ds for users — response body — item

Field	Type	Presence	Description and constraints
$	object	Root
accountId	JSON	Optional
accountId (anyOf 1)	string	Alternative
accountId (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
username	JSON	Optional
username (anyOf 1)	string	Alternative
username (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.bulkgetusersmigration. Catalog operation: bulkgetusersmigration. 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