Atlassian: Application roles schemas
1 Atlassian schema with complete fields and constraints.
← Application roles operations · All 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