com.atlassian.jira.rest.v2.admin.permissionscheme

Class PermissionSchemeResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource

public final class PermissionSchemeResource
extends Object

Resource for managing permission schemes and their attributes.

Permission scheme is a collection of permission grants. Each grant holds information about a permission granted to a group of users. These groups of users are called holders and are defined by two values: type and parameter. Type can be for example "group", or "user" and parameter is an additional specification. In case of groups the parameter will hold the group name, and in case of users: user id.

Types can be extended by plugins, but here is a list of all built-in types (expected parameter contents are given in parenthesis):

anyone

Grant for anonymous users.

group (group name)

Grant for the specified group

user (user id)

Grant for the specified user

projectRole (project role id)

Grant for the specified project role

reporter

Grant for an issue reported

projectLead

Grant for a project lead

assignee

Grant for a user assigned to an issue

userCustomField (custom field id)

Grant for a user selected in the specified custom field

groupCustomField (custom field id)

Grant for a user selected in the specified custom field

There are also two "hidden" holder types, which are not available in on-demand but can be used in enterprise instances:

reporterWithCreatePermission

This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has create permission and issues within that where they are the reporter.

assigneeWithAssignablePermission

This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has the assignable permission and issues within that where they are the assignee.

In addition to specifying the permission holder, a permission must be selected. That way a pair of (holder, permission) is created and it represents a single permission grant.

Custom permissions can be added by plugins, but below we present a set of built-in JIRA permissions.

• ADMINISTER_PROJECTS
• BROWSE_PROJECTS
• VIEW_DEV_TOOLS
• VIEW_READONLY_WORKFLOW
• CREATE_ISSUES
• EDIT_ISSUES
• TRANSITION_ISSUES
• SCHEDULE_ISSUES
• MOVE_ISSUES
• ASSIGN_ISSUES
• ASSIGNABLE_USER
• RESOLVE_ISSUES
• CLOSE_ISSUES
• MODIFY_REPORTER
• DELETE_ISSUES
• LINK_ISSUES
• SET_ISSUE_SECURITY
• VIEW_VOTERS_AND_WATCHERS
• MANAGE_WATCHERS
• ADD_COMMENTS
• EDIT_ALL_COMMENTS
• EDIT_OWN_COMMENTS
• DELETE_ALL_COMMENTS
• DELETE_OWN_COMMENTS
• CREATE_ATTACHMENTS
• DELETE_ALL_ATTACHMENTS
• DELETE_OWN_ATTACHMENTS
• WORK_ON_ISSUES
• EDIT_OWN_WORKLOGS
• EDIT_ALL_WORKLOGS
• DELETE_OWN_WORKLOGS
• DELETE_ALL_WORKLOGS

Since:

7.4 managing permission scheme attributes

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_PATH
static String	RESOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
PermissionSchemeResource(JiraAuthenticationContext authenticationContext, PermissionSchemeBeansFactory beansFactory, PermissionGrantBeanExpander permissionGrantBeanExpander, PermissionSchemeService permissionSchemeService, I18nHelper i18n, ResponseFactory responseFactory, GlobalPermissionManager globalPermissionManager, PermissionSchemeAttributeManager permissionSchemeAttributeManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	asAdmin(com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.RestAction action)
javax.ws.rs.core.Response	createPermissionGrant(Long schemeId, PermissionGrantBean grantBean, String expand) Creates a permission grant in a permission scheme.
javax.ws.rs.core.Response	createPermissionScheme(PermissionSchemeBean permissionScheme, String expand) Create a new permission scheme.
javax.ws.rs.core.Response	deletePermissionScheme(Long id) Deletes a permission scheme identified by the given id.
javax.ws.rs.core.Response	deletePermissionSchemeEntity(Long schemeId, Long permissionId) Deletes a permission grant from a permission scheme.
javax.ws.rs.core.Response	getPermissionScheme(Long id, String expand) Returns a permission scheme identified by the given id.
javax.ws.rs.core.Response	getPermissionSchemeGrant(Long schemeId, Long permissionId, String expand) Returns a permission grant identified by the given id.
javax.ws.rs.core.Response	getPermissionSchemeGrants(Long schemeId, String expand) Returns all permission grants of the given permission scheme.
javax.ws.rs.core.Response	getPermissionSchemes(String expand) Returns a list of all permission schemes.
javax.ws.rs.core.Response	getSchemeAttribute(Long schemeId, String key)
javax.ws.rs.core.Response	setSchemeAttribute(Long schemeId, String key, String value) Updates or inserts the attribute for a permission scheme specified by permission scheme id.
javax.ws.rs.core.Response	updatePermissionScheme(Long schemeId, PermissionSchemeBean permissionScheme, String expand) Updates a permission scheme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

ENTITY_PATH

public static final String ENTITY_PATH

See Also:

Constant Field Values

Constructor Detail

PermissionSchemeResource

public PermissionSchemeResource(JiraAuthenticationContext authenticationContext,
                                PermissionSchemeBeansFactory beansFactory,
                                PermissionGrantBeanExpander permissionGrantBeanExpander,
                                PermissionSchemeService permissionSchemeService,
                                I18nHelper i18n,
                                ResponseFactory responseFactory,
                                GlobalPermissionManager globalPermissionManager,
                                PermissionSchemeAttributeManager permissionSchemeAttributeManager)

Method Detail

getPermissionSchemes

public javax.ws.rs.core.Response getPermissionSchemes(String expand)

Returns a list of all permission schemes.

By default only shortened beans are returned. If you want to include permissions of all the schemes, then specify the permissions expand parameter. Permissions will be included also if you specify any other expand parameter.

Returns:

a list of all permission schemes.

getPermissionScheme

public javax.ws.rs.core.Response getPermissionScheme(Long id,
                                                     String expand)

Returns a permission scheme identified by the given id.

Returns:

a permission scheme.

deletePermissionScheme

public javax.ws.rs.core.Response deletePermissionScheme(Long id)

Deletes a permission scheme identified by the given id.

createPermissionScheme

public javax.ws.rs.core.Response createPermissionScheme(PermissionSchemeBean permissionScheme,
                                                        String expand)

Create a new permission scheme. This method can create schemes with a defined permission set, or without.

Returns:

a newly created scheme

updatePermissionScheme

public javax.ws.rs.core.Response updatePermissionScheme(Long schemeId,
                                                        PermissionSchemeBean permissionScheme,
                                                        String expand)

Updates a permission scheme.

If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.

To update just the name and description, do not send permissions list at all.

To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.

Returns:

a newly updated scheme

getSchemeAttribute

@ExperimentalApi
public javax.ws.rs.core.Response getSchemeAttribute(Long schemeId,
                                                                     String key)

Parameters:

schemeId - permission scheme id

key - permission scheme attribute key

Returns:

the json representation of the attribute for given permission scheme id and attribute key

setSchemeAttribute

@ExperimentalApi
public javax.ws.rs.core.Response setSchemeAttribute(Long schemeId,
                                                                     String key,
                                                                     String value)

Updates or inserts the attribute for a permission scheme specified by permission scheme id. The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.

Parameters:

schemeId - permission scheme id

key - permission scheme attribute key

value - permission scheme attribute value passed as the request body

Returns:

no content response

getPermissionSchemeGrants

public javax.ws.rs.core.Response getPermissionSchemeGrants(Long schemeId,
                                                           String expand)

Returns all permission grants of the given permission scheme.

Returns:

a permission scheme entities list.

createPermissionGrant

public javax.ws.rs.core.Response createPermissionGrant(Long schemeId,
                                                       PermissionGrantBean grantBean,
                                                       String expand)

Creates a permission grant in a permission scheme.

Returns:

a newly created permission

deletePermissionSchemeEntity

public javax.ws.rs.core.Response deletePermissionSchemeEntity(Long schemeId,
                                                              Long permissionId)

Deletes a permission grant from a permission scheme.

Returns:

no content response

getPermissionSchemeGrant

public javax.ws.rs.core.Response getPermissionSchemeGrant(Long schemeId,
                                                          Long permissionId,
                                                          String expand)

Returns a permission grant identified by the given id.

Returns:

the permission grant

asAdmin

public javax.ws.rs.core.Response asAdmin(com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.RestAction action)