Atlassian: Get all permissions

Atlassian permissions.getAllPermissions: arguments, response, policy and SDK examples.

Operation atlassian.getallpermissions

Provider route: GET /{cloudId}/rest/api/3/permissions. 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"]["getAllPermissions"]>[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.getAllPermissions(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_all_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}$

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 my permissions — response body

Referenced models: Get my permissions — response body

Schemas

Get my permissions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about permissions.
`permissions`	JSON	Optional
`permissions (anyOf 1)`	object	Alternative	List of permissions. Read only: true Additional keys: see wildcard field
`permissions (anyOf 1).*`	Model	Additional keys	Expand Get my permissions — response body — permissions List of permissions value
`permissions (anyOf 2)`	null	Alternative

Referenced models: Get my permissions — response body — permissions List of permissions value

Get my permissions — response body — permissions List of permissions value

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission and its availability to a user. Additional keys: allowed
`deprecatedKey`	JSON	Optional
`deprecatedKey (anyOf 1)`	boolean	Alternative	Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`
`deprecatedKey (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the permission.
`description (anyOf 2)`	null	Alternative
`havePermission`	JSON	Optional
`havePermission (anyOf 1)`	boolean	Alternative	Whether the permission is available to the user in the queried context.
`havePermission (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the permission.
`name (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of the permission. Known values: GLOBAL, PROJECT
`type (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getallpermissions. Catalog operation: getallpermissions. 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: ["manage:jira-configuration"]

Official provider source

Report an issue with this page