GET /rest/api/2/permissionscheme

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder object

The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group", and the parameter is the group name, "parameter": "Teams in space administrators" and the value is group ID, "value": "ca85fac0-d974-40ca-a615-7af99c48d24f".

The holder object is defined by the following properties:

type Identifies the user or group (see the list of types below).
parameter As a group's name can change, use of value is recommended. The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.
value The value of this property depends on the type. If the type is a group, then you need to specify the group ID. For other type it has the same value as parameter

The following types are available. The expected values for parameter and value are given in parentheses (some types may not have a parameter or value):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name, application name). See Update product access settings for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (parameter : group name, value : group ID).
groupCustomField Grant for a user in the group selected in the specified custom field (parameter : custom field ID, value : custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (parameter :project role ID, value : project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (parameter : user ID - historically this was the userkey but that is deprecated and the account ID should be used, value : user ID).
userCustomField Grant for a user selected in the specified custom field (parameter : custom field ID, value : custom field ID).

Built-in permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Administration permissions

ADMINISTER_PROJECTS
EDIT_WORKFLOW
EDIT_ISSUE_LAYOUT

Project permissions

BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

Servers

https://your-domain.atlassian.net

Query parameters

Name Type Required Description

Name	Type	Required	Description
`expand`	String	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: `all` Returns all expandable information. `field` Returns information about the custom field granted the permission. `group` Returns information about the group that is granted the permission. `permissions` Returns all permission grants for each permission scheme. `projectRole` Returns information about the project role granted the permission. `user` Returns information about the user who is granted the permission.

expand

String

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.