Atlassian: Convert user identifiers to account I Ds in JQL queries

← Jql operations · Get started

Operation atlassian.migratequeries

Provider route: POST /{cloudId}/rest/api/3/jql/pdcleaner. 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["jql"]["migrateQueries"]>[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.jql.migrateQueries(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.jql.migrate_queries(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}$
body	Model	Required within parent	Expand Convert user identifiers to account I Ds in JQL queries — request body — body

Referenced models: Convert user identifiers to account I Ds in JQL queries — request body — body

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 Convert user identifiers to account I Ds in JQL queries — response body

Referenced models: Convert user identifiers to account I Ds in JQL queries — response body

Schemas

Convert user identifiers to account I Ds in JQL queries — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The JQL queries to be converted. Additional keys: not allowed
queryStrings	array	Optional	A list of queries with user identifiers. Maximum of 100 queries.
queryStrings[]	string	Each item

Convert user identifiers to account I Ds in JQL queries — response body

Field	Type	Presence	Description and constraints
$	object	Root	The converted JQL queries.
queriesWithUnknownUsers	JSON	Optional
queriesWithUnknownUsers (anyOf 1)	array	Alternative	List of queries containing user information that could not be mapped to an existing user
queriesWithUnknownUsers (anyOf 1)[]	Model	Each item	Expand Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item
queriesWithUnknownUsers (anyOf 2)	null	Alternative
queryStrings	JSON	Optional
queryStrings (anyOf 1)	array	Alternative	The list of converted query strings with account IDs in place of user identifiers.
queryStrings (anyOf 1)[]	string	Each item
queryStrings (anyOf 2)	null	Alternative

Referenced models: Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item

Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item

Field	Type	Presence	Description and constraints
$	object	Root	JQL queries that contained users that could not be found
convertedQuery	JSON	Optional
convertedQuery (anyOf 1)	string	Alternative	The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found
convertedQuery (anyOf 2)	null	Alternative
originalQuery	JSON	Optional
originalQuery (anyOf 1)	string	Alternative	The original query, for reference
originalQuery (anyOf 2)	null	Alternative

Policy, approvals and errors

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