Cloud

Jira Cloud platform / Reference / REST API v3

Application roles

Postman Collection

OpenAPI

This resource represents application roles. Use it to get details of an application role or all application roles.

Operations

GET/rest/api/3/applicationrole GET/rest/api/3/applicationrole/{key}

GET

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.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-configuration

Granular:read:application-role:jira

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

array<ApplicationRole>

GET/rest/api/3/applicationrole

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

const response = await requestJira(`/rest/api/3/applicationrole`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

[
  {
    "defaultGroups": [
      "jira-software-users"
    ],
    "defaultGroupsDetails": [
      {
        "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
        "name": "jira-software-users",
        "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      }
    ],
    "defined": false,
    "groupDetails": [
      {
        "groupId": "42c8955c-63d7-42c8-9520-63d7aca0625",
        "name": "jira-testers",
        "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625"
      },
      {
        "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
        "name": "jira-software-users",
        "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      }
    ],
    "groups": [
      "jira-software-users",
      "jira-testers"
    ],
    "hasUnlimitedSeats": false,
    "key": "jira-software",
    "name": "Jira Software",
    "numberOfSeats": 10,
    "platform": false,
    "remainingSeats": 5,
    "selectedByDefault": false,
    "userCount": 5,
    "userCountDescription": "5 developers"
  },
  {
    "defaultGroups": [
      "jira-core-users"
    ],
    "defaultGroupsDetails": [
      {
        "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
        "name": "jira-core-users",
        "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
      }
    ],
    "defined": false,
    "groupDetails": [
      {
        "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
        "name": "jira-core-users",
        "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
      }
    ],
    "groups": [
      "jira-core-users"
    ],
    "hasUnlimitedSeats": false,
    "key": "jira-core",
    "name": "Jira Core",
    "numberOfSeats": 1,
    "platform": true,
    "remainingSeats": 1,
    "selectedByDefault": false,
    "userCount": 0,
    "userCountDescription": "0 users"
  }
]

GET

Get application role

Returns an application role.