Atlassian · Schema

ApplicationRole

Details of an application role.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
defaultGroups	array	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.
defaultGroupsDetails	array	The groups that are granted default access for this application role.
defined	boolean	Deprecated.
groupDetails	array	The groups associated with the application role.
groups	array	The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups.
hasUnlimitedSeats	boolean
key	string	The key of the application role.
name	string	The display name of the application role.
numberOfSeats	integer	The maximum count of users on your license.
platform	boolean	Indicates if the application role belongs to Jira platform (`jira-core`).
remainingSeats	integer	The count of users remaining on your license.
selectedByDefault	boolean	Determines whether this application role should be selected by default on user creation.
userCount	integer	The number of users counting against your license.
userCountDescription	string	The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApplicationRole",
  "title": "ApplicationRole",
  "additionalProperties": false,
  "description": "Details of an application role.",
  "properties": {
    "defaultGroups": {
      "description": "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.",
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "defaultGroupsDetails": {
      "description": "The groups that are granted default access for this application role.",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      },
      "type": "array"
    },
    "defined": {
      "description": "Deprecated.",
      "type": "boolean"
    },
    "groupDetails": {
      "description": "The groups associated with the application role.",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      },
      "type": "array"
    },
    "groups": {
      "description": "The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups.",
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "hasUnlimitedSeats": {
      "type": "boolean"
    },
    "key": {
      "description": "The key of the application role.",
      "type": "string"
    },
    "name": {
      "description": "The display name of the application role.",
      "type": "string"
    },
    "numberOfSeats": {
      "description": "The maximum count of users on your license.",
      "format": "int32",
      "type": "integer"
    },
    "platform": {
      "description": "Indicates if the application role belongs to Jira platform (`jira-core`).",
      "type": "boolean"
    },
    "remainingSeats": {
      "description": "The count of users remaining on your license.",
      "format": "int32",
      "type": "integer"
    },
    "selectedByDefault": {
      "description": "Determines whether this application role should be selected by default on user creation.",
      "type": "boolean"
    },
    "userCount": {
      "description": "The number of users counting against your license.",
      "format": "int32",
      "type": "integer"
    },
    "userCountDescription": {
      "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
      "type": "string"
    }
  },
  "type": "object"
}