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.
Checklist Permissions
In Issue Checklist Free, users can see/edit the checklist if they can see/edit the issue.
This is also the default for Issue Checklist Pro. However, in Issue Checklist Pro, you can customize permissions to control who can view/add/edit/toggle/delete checklist items.
Understanding the Custom Work on Checklist Permission
The custom Work one Checklist permission can be used to control who can add, edit, toggle and delete checklists regardless of whether or not a 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 |
---|---|---|---|
|
|
|
|
*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 | Add Checklist Items | Edit Checklist Items | Toggle Checklist Items | Delete Checklist Items |
**Disabled Company-managed / Classic projects: | Edit Issues | Edit Issues | Edit Issues | Edit Issues |
**Disabled Team-managed / Next-gen projects | Member or higher | Member or higher | Member or higher | Member or higher |
**Disabled is the only option for Issue Checklist Free, and the default option for Issue Checklist Pro.
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
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 appropriate checklist permissions.
Select the users/groups who will be added to the role.
Click Create.
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.
If a user is allowed to view the checklist but not edit it, the checklist will be displayed in read-only mode: all items will be visible but it won't be possible for the user to make any changes.
If the Save checklist data to Jira custom fields setting is enabled and the Checklist Text field is included on Jira screens, then the checklist content will be visible to users regardless of whether or not they have permission to view the list.
Global View Checklist Permission | Permission Required to View Checklist |
---|---|
Enabled | View Checklist |
Disabled This is the only option for Issue Checklist Free, and the default option for Issue Checklist Pro. |
|
If the View Checklist custom permission is in use, and a user does not have this permission, he/she can still see assigned checklist items on Assigned checklist items page.
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.
This will render the checklists invisible 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 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
This can only be done with Company-managed (Classic) projects. Team-managed (Next-gen) projects do not currently support permissions for dynamic fields.
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
Please note that similar to Jira, Issue Checklist allows System Administrators to perform actions that require Administer Project permission.
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 | Add Checklist Items |
Load template (append) | Edit Issues | Add Checklist Items |
Load template (overwrite) | Edit Issues | Add Checklist Items + Delete Checklist Items |
Edit template (author) | Browse Projects | Browse Projects |
Edit template (all) | Administer Projects | Administer Projects |
Delete template (author) | Browse Projects | Browse Projects |
Delete template (all) | Administer Projects | Administer Projects |
Set default template | Administer Projects | Administer Projects |
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 or higher role | Viewer or higher role |
Create template | "Member" or higher role | Add Checklist Items |
Load template (append) | Member or higher role | Add Checklist Items |
Load template (overwrite) | Member or higher role | Add Checklist Items + Delete Checklist Items |
Edit template (author) | Viewer or higher role | Viewer or higher role |
Edit template (all) | Administrator role | Administrator role |
Delete template (author) | Viewer or higher role | Viewer or higher role |
Delete template (all) | Administrator role | Administrator role |
Set default template | Administrator role | Administrator role |