Documentation

Global Permission

This module allows add-ons to define custom global permissions.

Global permissions are not related to any particular entity and are useful if you need to manage permissions for operations performed on global objects, like users or global settings.

A custom global permission behaves as any other JIRA permission. Administrators may manage it in the UI, and your add-on can access it through REST APIs. Permissions you define in your add-on can be used in the has_global_permission condition.

Note that there is a similar module for project permissions.

Example

{
  "modules": {
    "jiraGlobalPermissions": [
      {
        "description": {
          "value": "Custom global permission for my add-on"
        },
        "anonymousAllowed": false,
        "defaultGrants": [
          "all"
        ],
        "name": {
          "value": "My Global Permission"
        },
        "key": "my-global-permission"
      }
    ]
  }
}

Properties

description

Required
Yes
Description

Description of the global permission. It will be displayed under the permission's name.

key

Type
string
Required
Yes
Description

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Required
Yes
Description

A human readable name.

anonymousAllowed

Type
boolean
Defaults to
true
Description

Specifies if this permission can be granted to anonymous users.

defaultGrants

Type
string, … ]
Description

Specifies group of users that will be granted this permissions when the add-on is first installed.

Allowed values:

  • NONE - Permission will not be granted to anyone by default
  • ALL - If anonymousAllowed is set to true, every user, both logged in and anonymous, will be granted the permission. Otherwise, permission will be granted to every user with application role assigned.
  • JIRA-ADMINISTRATORS - Every user with jira administration permission will be granted this permission.