org.everit.atlassian.restclient.jiracloud.v2.api

Class PermissionSchemeApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.PermissionSchemeApi

public class PermissionSchemeApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PermissionSchemeApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PermissionGrant>	createPermissionGrant(Long schemeId, PermissionGrant permissionGrant, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create permission grant Creates a permission grant in a permission scheme.
io.reactivex.Single<PermissionScheme>	createPermissionScheme(PermissionScheme requestBody, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create permission scheme Creates a new permission scheme.
io.reactivex.Completable	deletePermissionScheme(Long schemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete permission scheme Deletes a permission scheme.
io.reactivex.Completable	deletePermissionSchemeEntity(Long schemeId, Long permissionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete permission scheme grant Deletes a permission grant from a permission scheme.
io.reactivex.Single<PermissionSchemes>	getAllPermissionSchemes(Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all permission schemes Returns all permission schemes.
io.reactivex.Single<PermissionScheme>	getPermissionScheme(Long schemeId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get permission scheme Returns a permission scheme.
io.reactivex.Single<PermissionGrant>	getPermissionSchemeGrant(Long schemeId, Long permissionId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get permission scheme grant Returns a permission grant.
io.reactivex.Single<PermissionGrants>	getPermissionSchemeGrants(Long schemeId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get permission scheme grants Returns all permission grants for a permission scheme.
io.reactivex.Single<PermissionScheme>	updatePermissionScheme(Long schemeId, PermissionScheme requestBody, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update permission scheme Updates a permission scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionSchemeApi

public PermissionSchemeApi(org.everit.http.restclient.RestClient restClient)

Method Detail

createPermissionGrant

public io.reactivex.Single<PermissionGrant> createPermissionGrant(Long schemeId,
                                                                  PermissionGrant permissionGrant,
                                                                  Optional<String> expand,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create permission grant

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

Parameters:

schemeId -

The ID of the permission scheme in which to create a new permission grant.

(required)

permissionGrant -

The permission grant to create.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:

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

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionGrant>

createPermissionScheme

public io.reactivex.Single<PermissionScheme> createPermissionScheme(PermissionScheme requestBody,
                                                                    Optional<String> expand,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create permission scheme

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

Parameters:

requestBody -

The permission scheme to create.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionScheme>

deletePermissionScheme

public io.reactivex.Completable deletePermissionScheme(Long schemeId,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete permission scheme

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

Parameters:

schemeId -

The ID of the permission scheme being deleted.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

deletePermissionSchemeEntity

public io.reactivex.Completable deletePermissionSchemeEntity(Long schemeId,
                                                             Long permissionId,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete permission scheme grant

Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

Parameters:

schemeId -

The ID of the permission scheme to delete the permission grant from.

(required)

permissionId -

The ID of the permission grant to delete.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getAllPermissionSchemes

public io.reactivex.Single<PermissionSchemes> getAllPermissionSchemes(Optional<String> expand,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all permission schemes

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". The holder object is defined by the following properties:

• type Identifies the user or group (see the list of types below).
• parameter 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.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

• anyone Grant for anonymous users.
• applicationRole Grant for users with access to the specified application (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 (group name).
• groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
• projectLead Grant for a project lead.
• projectRole Grant for the specified project role (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 (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
• userCustomField Grant for a user selected in the specified custom field (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.

Project permissions

• ADMINISTER_PROJECTS
• 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.

Parameters:

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionSchemes>

getPermissionScheme

public io.reactivex.Single<PermissionScheme> getPermissionScheme(Long schemeId,
                                                                 Optional<String> expand,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get permission scheme

Returns a permission scheme.

Permissions required: Permission to access Jira.

Parameters:

schemeId -

The ID of the permission scheme to return.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionScheme>

getPermissionSchemeGrant

public io.reactivex.Single<PermissionGrant> getPermissionSchemeGrant(Long schemeId,
                                                                     Long permissionId,
                                                                     Optional<String> expand,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get permission scheme grant

Returns a permission grant.

Permissions required: Permission to access Jira.

Parameters:

schemeId -

The ID of the permission scheme.

(required)

permissionId -

The ID of the permission grant.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionGrant>

getPermissionSchemeGrants

public io.reactivex.Single<PermissionGrants> getPermissionSchemeGrants(Long schemeId,
                                                                       Optional<String> expand,
                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get permission scheme grants

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

Parameters:

schemeId -

The ID of the permission scheme.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:

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

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionGrants>

updatePermissionScheme

public io.reactivex.Single<PermissionScheme> updatePermissionScheme(Long schemeId,
                                                                    PermissionScheme requestBody,
                                                                    Optional<String> expand,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update permission scheme

Updates a permission scheme. Below are some important things to note when using this resource:

• If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
• If you want to update only the name and description, then do not send a permissions list in the request.
• Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

Parameters:

schemeId -

The ID of the permission scheme to update.

(required)

requestBody - (required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PermissionScheme>