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

Class ProjectPermissionSchemesApi

java.lang.Object

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

public class ProjectPermissionSchemesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectPermissionSchemesApi(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](https://confluence.atlassian.com/x/yodKLg) associated with the project.
io.reactivex.Single<SecurityScheme>	getProjectIssueSecurityScheme(String projectKeyOrId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project issue security scheme Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project.
io.reactivex.Single<ProjectIssueSecurityLevels>	getSecurityLevelsForProject(String projectKeyOrId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project issue security levels Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the user has access to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectPermissionSchemesApi

public ProjectPermissionSchemesApi(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](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)

Parameters:

projectKeyOrId - The project ID or project key (case sensitive). (required)

idBean - (required)

expand - Use [expand](#expansion) 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. (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](https://confluence.atlassian.com/x/yodKLg) associated with the project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).

Parameters:

projectKeyOrId - The project ID or project key (case sensitive). (required)

expand - Use [expand](#expansion) 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. (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>

getProjectIssueSecurityScheme

public io.reactivex.Single<SecurityScheme> getProjectIssueSecurityScheme(String projectKeyOrId,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project issue security scheme Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or the *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).

Parameters:

projectKeyOrId - The project ID or project key (case sensitive). (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<SecurityScheme>

getSecurityLevelsForProject

public io.reactivex.Single<ProjectIssueSecurityLevels> getSecurityLevelsForProject(String projectKeyOrId,
                                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project issue security levels Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the user has access to. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project, however, issue security levels are only returned for authenticated user with *Set Issue Security* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project.

Parameters:

projectKeyOrId - The project ID or project key (case sensitive). (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<ProjectIssueSecurityLevels>