• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v2

Application roles

Postman Collection
OpenAPI

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

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

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/2/applicationrole
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/api/2/applicationrole`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 [ { "defaultGroups": [ "jira-software-users" ], "defaultGroupsDetails": [ { "groupId": "276f955c-63d7-42c8-9520-92d01dca0625", "name": "jira-software-users", "self": "https://your-domain.atlassian.net/rest/api/2/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/2/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/2/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/2/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/2/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.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

Path parameters

key

string

Required

Responses

Returned if the request is successful.

application/json

ApplicationRole

Details of an application role.

GET/rest/api/2/applicationrole/{key}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/api/2/applicationrole/{key}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 { "defaultGroups": [ "jira-software-users" ], "defaultGroupsDetails": [ { "groupId": "276f955c-63d7-42c8-9520-92d01dca0625", "name": "jira-software-users", "self": "https://your-domain.atlassian.net/rest/api/2/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/2/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/2/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" }

Rate this page: