• About Connect modules for Jira
  • Admin Page
  • Administration UI locations
  • Build
  • Dashboard Item
  • Deployment
  • Development Tool
  • Dialog
  • Entity Property
  • Feature Flag
  • Global Permission
  • Home container
  • Issue Background Script
  • Issue Content
  • Issue Field
  • Issue Glance
  • Issue view UI locations
  • Keyboard Shortcut
  • New issue view UI locations
  • Page
  • Project Admin Tab Panel
  • Project Page
  • Project Permission
  • Project settings UI locations
  • Project sidebar
  • Report
  • Search Request View
  • Tab Panel
  • Time Tracking Provider
  • User profile menu
  • Web Item
  • Web Panel
  • Web Section
  • Webhook
  • Workflow Condition
  • Workflow Post Function
  • Workflow Validator

Project Permission

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

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. Permissions you define in your add-on can be used in the has_project_permission condition.

Note that there is a similar module for global permissions.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "modules": {
    "jiraProjectPermissions": [
      {
        "description": {
          "value": "Custom project permission for attachments"
        },
        "category": "attachments",
        "name": {
          "value": "My Project Permission"
        },
        "key": "my-project-permission"
      }
    ]
  }
}

Properties

description

Type
object
Required
Yes
Description

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


key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$

name

Type
object
Required
Yes

category

Type
string
Defaults to
other
Allowed values
  • projects
  • PROJECTS
  • issues
  • ISSUES
  • voters_and_watchers
  • VOTERS_AND_WATCHERS
  • comments
  • COMMENTS
  • attachments
  • ATTACHMENTS
  • time_tracking
  • TIME_TRACKING
  • other
  • OTHER
  • Description

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


    conditions

    Type
    [compositeConditionBean,singleConditionBean, ... ]
    Description

    Conditions can be added to display only when all the given conditions are true.


    • System status
    • Privacy
    • Developer Terms
    • Trademark
    • Cookie Preferences
    • © 2019 Atlassian