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

Class PermissionsApi

java.lang.Object

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

public class PermissionsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Permissions>	getAllPermissions(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all permissions Returns all permissions, including: global permissions.
io.reactivex.Single<BulkPermissionGrants>	getBulkPermissions(BulkPermissionsRequestBean bulkPermissionsRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get bulk permissions Returns: for a list of global permissions, the global permissions granted to the user.
io.reactivex.Single<Permissions>	getMyPermissions(Optional<String> projectKey, Optional<String> projectId, Optional<String> issueKey, Optional<String> issueId, Optional<String> permissions, Optional<String> projectUuid, Optional<String> projectConfigurationUuid, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get my permissions Returns a list of permissions indicating which permissions the user has.
io.reactivex.Single<PermittedProjects>	getPermittedProjects(PermissionsKeysBean permissionsKeysBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get permitted projects Returns all the projects where the user is granted a list of project permissions.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsApi

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

Method Detail

getAllPermissions

public io.reactivex.Single<Permissions> getAllPermissions(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all permissions

Returns all permissions, including:

• global permissions.
• project permissions.
• global permissions added by plugins.

Permissions required: Administer Jira global permission.

Parameters:

restRequestEnhancer -

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

Returns:

Single<Permissions>

getBulkPermissions

public io.reactivex.Single<BulkPermissionGrants> getBulkPermissions(BulkPermissionsRequestBean bulkPermissionsRequestBean,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get bulk permissions

Returns:

• for a list of global permissions, the global permissions granted to the user.
• for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

• Invalid project and issue IDs are ignored.
• A maximum of 1000 projects and 1000 issues can be checked.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

bulkPermissionsRequestBean -

Details of the permissions to check.

(required)

restRequestEnhancer -

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

Returns:

Single<BulkPermissionGrants>

getMyPermissions

public io.reactivex.Single<Permissions> getMyPermissions(Optional<String> projectKey,
                                                         Optional<String> projectId,
                                                         Optional<String> issueKey,
                                                         Optional<String> issueId,
                                                         Optional<String> permissions,
                                                         Optional<String> projectUuid,
                                                         Optional<String> projectConfigurationUuid,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get my permissions

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

• in the global context, if the user has the project permission in any project.
• for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
• for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

This means that users may be shown as having an issue permission (such as EDIT_ISSUE) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUE permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUE permission for that issue.

Global permissions are unaffected by context.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

projectKey -

The key of project. Ignored if projectId is provided.

(optional)

projectId -

The ID of project.

(optional)

issueKey -

The key of the issue. Ignored if issueId is provided.

(optional)

issueId -

The ID of the issue.

(optional)

permissions -

A comma-separated list of permission keys. Omitting this parameter is deprecated. To get the list of available permissions, use Get all permissions. Note that deprecated keys cannot be used. Deprecated keys are not returned by Get all permissions but are returned by this operation if permissions is omitted.

(optional)

projectUuid - (optional)

projectConfigurationUuid - (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<Permissions>

getPermittedProjects

public io.reactivex.Single<PermittedProjects> getPermittedProjects(PermissionsKeysBean permissionsKeysBean,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get permitted projects

Returns all the projects where the user is granted a list of project permissions.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

permissionsKeysBean - (required)

restRequestEnhancer -

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

Returns:

Single<PermittedProjects>