We have a new documentation site. Please go here to see the latest.
Configure Permissions
By default, users who can view/edit the issue can view/edit the checklist. However, in Checklist for Jira Pro, you can configure custom checklist permissions that are independent of issue permissions.
- 1 Checklist Permissions
- 2 Limit Ability to View/Edit Checklists to Assignee
- 3 Template Permissions
Checklist Permissions
In Issue Checklist for Jira FREE , users can see/edit the checklist if they can see/edit the issue.
In Issue Checklist for Jira Pro and enterprise this is the default, however, you can choose to customize permissions to control who can view, add, edit, toggle, and delete checklist items.
Understanding the Custom Work on Checklist Permission
The custom Work on Checklist permission can be used to control who can add, edit, toggle and delete items on local checklists, and who can toggle items on Global checklists, regardless of whether or not the user has Edit issue permissions. Users with these permissions can:
| Add Checklist Items Permission | Edit Checklist Items Permission | Toggle Checklist Items Permission | Delete Checklist Items Permission |
|---|---|---|---|---|
Local Checklists |
|
|
|
|
Global Checklists | N/A | N/A |
| N/A |
*Loading templates in Overwrite mode requires both Add Checklist Item permission and Delete Checklist Item permission.
Note that to access the checklist Editor, the user must be granted all of the permissions (Add, Edit, Toggle, Delete).
Global View Checklist Permission | Permission required to | Permission required to Edit checklist item | Permission required to checklist item | Permission required to checklist item |
|---|---|---|---|---|
Enabled – Local Checklists | Add Checklist Items | Edit Checklist Items | Toggle Checklist Items | Delete Checklist Items |
**Disabled – Local Checklists Company-managed / Classic projects: | Edit Issues | Edit Issues | Edit Issues | Edit Issues |
**Disabled – Local Checklists Team-managed / Next-gen projects | Member, Agent or Administrator role | Member, Agent or Administrator role | Member, Agent or Administrator role | Member, Agent or Administrator role |
Enabled – Global Checklists | N/A | N/A | Toggle Checklist Items | N/A |
**Disabled – Global Checklists Company-managed / Classic projects: | N/A | N/A | Edit Issues | N/A |
**Disabled – Global Checklists Team-managed / Next-gen projects | N/A | N/A | Member, Agent or Administrator role | N/A |
**Disabled is the only option for Issue Checklist for Jira free, and the default option for Issue Checklist for Jira Pro and enterprise.
For checklists to function properly, if the custom Work on checklist permission is enabled then the Checklist Text custom field must not be present on the Issue Edit and Issue Create screens.
Using Custom Work on Checklist Permissions
To enable Checklist custom permissions, log in as a Jira administrator and go to Jira Settings > Apps and select Permissions under the Checklist for Jira heading. Use the toggle to enable custom permissions for who can work on checklists.
This will render all checklists read-only until Project permissions have been configured.
For Company-managed/Classic Projects
After enabling the toggle, navigate to Project Settings > Permissions.
Click Edit Permissions under the Actions menu.
Navigate to the appropriate checklist permission (under issue permissions) and click Edit.
Select the appropriate role, application access or group. You can also click Show more to select users from the issue’s fields (Assignee, Reporter, etc.)
Click Grant.
For Team-managed/Next-gen Projects
Understanding the Custom View Checklist Permission
The custom View Checklist permission can be used to control who can see checklist and the checklist history. This configuration allows you to hide the checklist for users who still have access to the issue.
Global View Checklist Permission | Permission Required to View Checklist |
|---|---|
Enabled | View Checklist |
Disabled This is the only option for Issue Checklist for Jira free, and the default option for Issue Checklist for Jira Pro and enterprise. |
|
Using the Custom View Checklist Permission
To enable custom View Checklist permissions, log in as a Jira administrator and go to Jira Settings > Apps and select Permissions under the Checklist for Jira heading. Use the toggle to enable custom permissions for who can view checklists.
For Company-managed/Classic Projects
After enabling the toggle, navigate to Project Settings > Permissions.
Click Edit Permissions under the Actions menu.
Navigate to the View Checklist permission (under issue permissions) and click Edit.
Select the appropriate role, application access or group. You can also click Show more to select users from the issue’s fields (Assignee, Reporter, etc.).
Click Grant.
For Team-managed/Next-gen Projects
After enabling the toggle, navigate to Project Settings > Access.
Click the Manage roles button (top right).
Click Create role and select the App permissions tab.
Give the new role a name.
Select the View Checklist permission.
Select the users/groups who will be added to the role.
Click Create.
Limit Ability to View/Edit Checklists to Assignee
To allow only the assignee to view and/or work on checklists:
Log in as a Jira administrator and go to Jira Settings > Apps and select Permissions under the Checklist for Jira heading. Use the toggles to enable the custom Work on checklist and the custom View Checklist permissions.
After enabling the toggle, navigate to Project Settings > Permissions. Click Edit Permissions under the Actions menu.
Navigate to the appropriate permission and click Edit.
Click Show more on the Grant permissions popup.
Select Current Assignee and click Grant. Note that may also want to grant permission to the Reporter, Project lead, etc.
Remove permission from any Groups or Roles who should not be able to make changes to the checklist.
Template Permissions
Understanding Template Permissions
If the custom Work on Checklist Permission is enabled, the ability to create templates is granted by adding the appropriate user, role or group the Manage Checklist Template project permission in the project’s permission scheme.
Company-managed (Classic) Projects
The following permissions are required to work with templates in Company-managed projects:
| Global custom Work on checklist permissions setting disabled | Global custom Work on checklist permissions setting enabled |
|---|---|---|
See templates | Browse Projects | Browse Projects |
Create template | Edit Issues | Manage Checklist Template |
Load template (append) | Edit Issues | Add Checklist Items |
Load template (overwrite) | Edit Issues | Add Checklist Items + Delete Checklist Items |
Edit template (author) | Browse Projects | Manage Checklist Template |
Edit template (all) | Administer Projects | Manage Checklist Template |
Delete template (author) | Browse Projects | Manage Checklist Template |
Delete template (all) | Administer Projects | Manage Checklist Template |
Set default template | Administer Projects | Manage Checklist Template |
Team-managed (Next-Gen) Projects
The following permissions are required to work with templates in Team-managed projects:
| Global custom Work on checklist permissions setting disabled | Global custom Work on checklist permissions setting enabled |
|---|---|---|
See templates | Viewer, Member, Agent or Administrator role | Viewer, Member, Agent or Administrator role |
Create template | Member, Agent or Administrator role | Create Checklist Template |
Load template (append) | Member, Agent or Administrator role | Add Checklist Items |
Load template (overwrite) | Member, Agent or Administrator role | Add Checklist Items + Delete Checklist Items |
Edit template (author) | Viewer, Member, Agent or Administrator role | Manage Checklist Template |
Edit template (all) | Administrator role | Manage Checklist Template |
Delete template (author) | Viewer, Member, Agent or Administrator role | Manage Checklist Template |
Delete template (all) | Administrator role | Manage Checklist Template |
Set default template | Administrator role | Manage Checklist Template |