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

Class ProjectPermissionSchemeApi

java.lang.Object

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

public class ProjectPermissionSchemeApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PermissionScheme>	assignPermissionScheme(String projectKeyOrId, IdBean idBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Assign permission scheme Assigns a permission scheme with a project.
io.reactivex.Single<PermissionScheme>	getAssignedPermissionScheme(String projectKeyOrId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get assigned permission scheme Gets the permission scheme associated with the project.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectPermissionSchemeApi

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

Method Detail

assignPermissionScheme

public io.reactivex.Single<PermissionScheme> assignPermissionScheme(String projectKeyOrId,
                                                                    IdBean idBean,
                                                                    Optional<String> expand,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign permission scheme

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Permissions required: Administer Jira global permission

Parameters:

projectKeyOrId -

The project ID or project key (case sensitive).

(required)

idBean - (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>

getAssignedPermissionScheme

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

Get assigned permission scheme

Gets the permission scheme associated with the project.

Permissions required: Administer Jira global permission or Administer projects project permission.

Parameters:

projectKeyOrId -

The project ID or project key (case sensitive).

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