Application roles

Get all application roles

Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

Permissions required: Administer Jira global permission.

get/rest/api/2/applicationrole

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/applicationrole
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Response

Returned if the request is successful.

defaultGroupsstring[]

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.

definedboolean

Deprecated.

groupsstring[]

The groups associated with the application role. As a group's name can change, use of groupDetails is recommended to identify a groups.

hasUnlimitedSeatsboolean
keystring

The key of the application role.

namestring

The display name of the application role.

numberOfSeatsinteger

The maximum count of users on your license.

platformboolean

Indicates if the application role belongs to Jira platform (jira-core).

remainingSeatsinteger

The count of users remaining on your license.

selectedByDefaultboolean

Determines whether this application role should be selected by default on user creation.

userCountinteger

The number of users counting against your license.

userCountDescriptionstring

The type of users being counted against your license.

Changes

No recorded changes to this operation across all 26 revisions of this API.