Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Rate this page:

Jira project permission (EAP)

The jira:projectPermission module allows you to define custom project permissions for Jira. Project permissions are scoped to projects and are useful if you need to manage permissions for operations performed on objects related to projects, like issues, comments, worklogs or your add-on's project-scoped entities.

A custom project permission behaves as any other Jira permission. Administrators may manage it in the UI, and your add-on can access it through REST APIs.

Note that there is a similar module for global permissions.

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

namestringYesThe name of the permission.
descriptionstringYesDescription of the project permission. It will be displayed under the permission's name.
categorystring

The category of the project permission. This determines in which section the permission will be displayed. Allowed values:

  • attachments
  • comments
  • issues
  • other
  • project
  • time_tracking
  • voters_and_watchers

Default: other

Example

1
2
modules:
  jira:projectPermission:
    - key: "forge-project-permission"
      name: "Forge project permission"
      description: "Forge custom project permission"
      category: attachments

Rate this page: