Atlassian: Get all application roles

Atlassian applicationRoles.getAllApplicationRoles: arguments, response, policy and SDK examples.

← Application roles operations · Get started

Operation atlassian.getallapplicationroles

Provider route: GET /{cloudId}/rest/api/3/applicationrole. 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["applicationRoles"]["getAllApplicationRoles"]>[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.applicationRoles.getAllApplicationRoles(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.application_roles.get_all_application_roles(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
`$`	array	Root
`$[]`	Model	Each item	Expand Get application role — response body

Referenced models: Get application role — response body

Schemas

Get application role — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an application role.
`defaultGroups`	JSON	Optional
`defaultGroups (anyOf 1)`	array	Alternative	The groups that are granted default access for this application role. As a group's name can change, use of `defaultGroupsDetails` is recommended to identify a groups. Unique items: true
`defaultGroups (anyOf 1)[]`	string	Each item
`defaultGroups (anyOf 2)`	null	Alternative
`defaultGroupsDetails`	JSON	Optional
`defaultGroupsDetails (anyOf 1)`	array	Alternative	The groups that are granted default access for this application role.
`defaultGroupsDetails (anyOf 1)[]`	Model	Each item	Expand Get user groups — response body — item
`defaultGroupsDetails (anyOf 2)`	null	Alternative
`defined`	JSON	Optional
`defined (anyOf 1)`	boolean	Alternative	Deprecated.
`defined (anyOf 2)`	null	Alternative
`groupDetails`	JSON	Optional
`groupDetails (anyOf 1)`	array	Alternative	The groups associated with the application role.
`groupDetails (anyOf 1)[]`	Model	Each item	Expand Get user groups — response body — item
`groupDetails (anyOf 2)`	null	Alternative
`groups`	JSON	Optional
`groups (anyOf 1)`	array	Alternative	The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups. Unique items: true
`groups (anyOf 1)[]`	string	Each item
`groups (anyOf 2)`	null	Alternative
`hasUnlimitedSeats`	JSON	Optional
`hasUnlimitedSeats (anyOf 1)`	boolean	Alternative
`hasUnlimitedSeats (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the application role.
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The display name of the application role.
`name (anyOf 2)`	null	Alternative
`numberOfSeats`	JSON	Optional
`numberOfSeats (anyOf 1)`	JSON	Alternative
`numberOfSeats (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum count of users on your license. Format: int32
`numberOfSeats (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`numberOfSeats (anyOf 2)`	null	Alternative
`platform`	JSON	Optional
`platform (anyOf 1)`	boolean	Alternative	Indicates if the application role belongs to Jira platform (`jira-core`).
`platform (anyOf 2)`	null	Alternative
`remainingSeats`	JSON	Optional
`remainingSeats (anyOf 1)`	JSON	Alternative
`remainingSeats (anyOf 1) (anyOf 1)`	integer	Alternative	The count of users remaining on your license. Format: int32
`remainingSeats (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`remainingSeats (anyOf 2)`	null	Alternative
`selectedByDefault`	JSON	Optional
`selectedByDefault (anyOf 1)`	boolean	Alternative	Determines whether this application role should be selected by default on user creation.
`selectedByDefault (anyOf 2)`	null	Alternative
`userCount`	JSON	Optional
`userCount (anyOf 1)`	JSON	Alternative
`userCount (anyOf 1) (anyOf 1)`	integer	Alternative	The number of users counting against your license. Format: int32
`userCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`userCount (anyOf 2)`	null	Alternative
`userCountDescription`	JSON	Optional
`userCountDescription (anyOf 1)`	string	Alternative	The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.
`userCountDescription (anyOf 2)`	null	Alternative

Referenced models: Get user groups — response body — item

Get user groups — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a group.
`groupId`	JSON	Optional
`groupId (anyOf 1)`	JSON	Alternative
`groupId (anyOf 1) (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 1) (anyOf 2)`	null	Alternative
`groupId (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of group.
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL for these group details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Policy, approvals and errors

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