Atlassian: Get bulk permissions

← Permissions operations · Get started

Operation atlassian.getbulkpermissions

Provider route: POST /{cloudId}/rest/api/3/permissions/check. 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["permissions"]["getBulkPermissions"]>[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.permissions.getBulkPermissions(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.permissions.get_bulk_permissions(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 Get bulk permissions — request body — body

Referenced models: Get bulk permissions — 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 Get bulk permissions — response body

Referenced models: Get bulk permissions — response body

Schemas

Get bulk permissions — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of global permissions to look up and project permissions with associated projects and issues to look up. Additional keys: not allowed
accountId	string	Optional	The account ID of a user.
globalPermissions	array	Optional	Global permissions to look up. Unique items: true
globalPermissions[]	string	Each item
projectPermissions	array	Optional	Project permissions with associated projects and issues to look up. Unique items: true
projectPermissions[]	Model	Each item	Expand Get bulk permissions — request body — body project Permissions item

Referenced models: Get bulk permissions — request body — body project Permissions item

Get bulk permissions — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of global and project permissions granted to the user.
globalPermissions	JSON	Optional
globalPermissions (anyOf 1)	array	Alternative	List of permissions granted to the user. Unique items: true
globalPermissions (anyOf 1)[]	string	Each item
globalPermissions (anyOf 2)	null	Alternative
projectPermissions	JSON	Optional
projectPermissions (anyOf 1)	array	Alternative	List of project permissions and the projects and issues those permissions provide access to. Unique items: true
projectPermissions (anyOf 1)[]	Model	Each item	Expand Get bulk permissions — response body — project Permissions array item
projectPermissions (anyOf 2)	null	Alternative

Referenced models: Get bulk permissions — response body — project Permissions array item

Get bulk permissions — request body — body project Permissions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of project permissions and associated issues and projects to look up. Additional keys: not allowed
issues	array	Optional	List of issue IDs. Unique items: true
issues[]	integer	Each item	Format: int64
permissions	array	Required within parent	List of project permissions. Unique items: true
permissions[]	string	Each item
projects	array	Optional	List of project IDs. Unique items: true
projects[]	integer	Each item	Format: int64

Get bulk permissions — response body — project Permissions array item

Field	Type	Presence	Description and constraints
$	object	Root	List of project permissions and the projects and issues those permissions grant access to.
issues	JSON	Optional
issues (anyOf 1)	array	Alternative	IDs of the issues the user has the permission for. Unique items: true
issues (anyOf 1)[]	JSON	Each item
issues (anyOf 1)[] (anyOf 1)	integer	Alternative	Format: int64
issues (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issues (anyOf 2)	null	Alternative
permission	JSON	Optional
permission (anyOf 1)	string	Alternative	A project permission,
permission (anyOf 2)	null	Alternative
projects	JSON	Optional
projects (anyOf 1)	array	Alternative	IDs of the projects the user has the permission for. Unique items: true
projects (anyOf 1)[]	JSON	Each item
projects (anyOf 1)[] (anyOf 1)	integer	Alternative	Format: int64
projects (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projects (anyOf 2)	null	Alternative

Policy, approvals and errors

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

Official provider source