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

Class IssueSecuritySchemesApi

java.lang.Object

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

public class IssueSecuritySchemesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addSecurityLevel(String schemeId, AddSecuritySchemeLevelsRequestBean addSecuritySchemeLevelsRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add issue security levels Adds levels and levels' members to the issue security scheme.
io.reactivex.Single<Object>	addSecurityLevelMembers(String schemeId, String levelId, SecuritySchemeMembersRequest securitySchemeMembersRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add issue security level members Adds members to the issue security level.
io.reactivex.Completable	associateSchemesToProjects(AssociateSecuritySchemeWithProjectDetails associateSecuritySchemeWithProjectDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Associate security scheme to project Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided.
io.reactivex.Single<SecuritySchemeId>	createIssueSecurityScheme(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create issue security scheme Creates a security scheme with security scheme levels and levels' members.
io.reactivex.Single<Object>	deleteSecurityScheme(String schemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue security scheme Deletes an issue security scheme.
io.reactivex.Single<SecurityScheme>	getIssueSecurityScheme(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue security scheme Returns an issue security scheme along with its security levels.
io.reactivex.Single<SecuritySchemes>	getIssueSecuritySchemes(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue security schemes Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg).
io.reactivex.Single<PageBeanSecurityLevelMember>	getSecurityLevelMembers(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<List<String>> schemeId, Optional<List<String>> levelId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue security level members Returns a [paginated](#pagination) list of issue security level members.
io.reactivex.Single<PageBeanSecurityLevel>	getSecurityLevels(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<List<String>> schemeId, Optional<Boolean> onlyDefault, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue security levels Returns a [paginated](#pagination) list of issue security levels.
io.reactivex.Completable	removeLevel(String schemeId, String levelId, Optional<String> replaceWith, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove issue security level Deletes an issue security level.
io.reactivex.Single<Object>	removeMemberFromSecurityLevel(String schemeId, String levelId, String memberId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove member from issue security level Removes an issue security level member from an issue security scheme.
io.reactivex.Single<PageBeanIssueSecuritySchemeToProjectMapping>	searchProjectsUsingSecuritySchemes(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> issueSecuritySchemeId, Optional<List<String>> projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get projects using issue security schemes Returns a [paginated](#pagination) mapping of projects that are using security schemes.
io.reactivex.Single<PageBeanSecuritySchemeWithProjects>	searchSecuritySchemes(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<List<String>> projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search issue security schemes Returns a [paginated](#pagination) list of issue security schemes.
io.reactivex.Single<Object>	setDefaultLevels(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set default issue security levels Sets default issue security levels for schemes.
io.reactivex.Single<Object>	updateIssueSecurityScheme(String id, UpdateIssueSecuritySchemeRequestBean updateIssueSecuritySchemeRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update issue security scheme Updates the issue security scheme.
io.reactivex.Single<Object>	updateSecurityLevel(String schemeId, String levelId, Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update issue security level Updates the issue security level.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueSecuritySchemesApi

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

Method Detail

addSecurityLevel

public io.reactivex.Single<Object> addSecurityLevel(String schemeId,
                                                    AddSecuritySchemeLevelsRequestBean addSecuritySchemeLevelsRequestBean,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add issue security levels Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme. (required)

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

addSecurityLevelMembers

public io.reactivex.Single<Object> addSecurityLevelMembers(String schemeId,
                                                           String levelId,
                                                           SecuritySchemeMembersRequest securitySchemeMembersRequest,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add issue security level members Adds members to the issue security level. You can add up to 100 members per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme. (required)

levelId - The ID of the issue security level. (required)

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

associateSchemesToProjects

public io.reactivex.Completable associateSchemesToProjects(AssociateSecuritySchemeWithProjectDetails associateSecuritySchemeWithProjectDetails,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Associate security scheme to project Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided. This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

createIssueSecurityScheme

public io.reactivex.Single<SecuritySchemeId> createIssueSecurityScheme(Map<String,Object> requestBody,
                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create issue security scheme Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme levels and security scheme levels' members per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

deleteSecurityScheme

public io.reactivex.Single<Object> deleteSecurityScheme(String schemeId,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue security scheme Deletes an issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme. (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<Object>

getIssueSecurityScheme

public io.reactivex.Single<SecurityScheme> getIssueSecurityScheme(Long id,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue security scheme Returns an issue security scheme along with its security levels. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses the requested issue security scheme.

Parameters:

id - The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-2-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. (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>

getIssueSecuritySchemes

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

Get issue security schemes Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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

getSecurityLevelMembers

public io.reactivex.Single<PageBeanSecurityLevelMember> getSecurityLevelMembers(Optional<String> startAt,
                                                                                Optional<String> maxResults,
                                                                                Optional<List<String>> id,
                                                                                Optional<List<String>> schemeId,
                                                                                Optional<List<String>> levelId,
                                                                                Optional<String> expand,
                                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue security level members Returns a [paginated](#pagination) list of issue security level members. Only issue security level members in the context of classic projects are returned. Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

id - The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: `id=10000&id=10001`. (optional, default to new ArrayList<>())

schemeId - The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: `schemeId=10000&schemeId=10001`. (optional, default to new ArrayList<>())

levelId - The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: `levelId=10000&levelId=10001`. (optional, default to new ArrayList<>())

expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. 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 * `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<PageBeanSecurityLevelMember>

getSecurityLevels

public io.reactivex.Single<PageBeanSecurityLevel> getSecurityLevels(Optional<String> startAt,
                                                                    Optional<String> maxResults,
                                                                    Optional<List<String>> id,
                                                                    Optional<List<String>> schemeId,
                                                                    Optional<Boolean> onlyDefault,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue security levels Returns a [paginated](#pagination) list of issue security levels. Only issue security levels in the context of classic projects are returned. Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

id - The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: `id=10000&id=10001`. (optional, default to new ArrayList<>())

schemeId - The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: `schemeId=10000&schemeId=10001`. (optional, default to new ArrayList<>())

onlyDefault - When set to true, returns multiple default levels for each security scheme containing a default. If you provide scheme and level IDs not associated with the default, returns an empty page. The default value is false. (optional, default to false)

restRequestEnhancer -

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

Returns:

Single<PageBeanSecurityLevel>

removeLevel

public io.reactivex.Completable removeLevel(String schemeId,
                                            String levelId,
                                            Optional<String> replaceWith,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove issue security level Deletes an issue security level. This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme. (required)

levelId - The ID of the issue security level to remove. (required)

replaceWith - The ID of the issue security level that will replace the currently selected level. (optional)

restRequestEnhancer -

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

Returns:

Completable

removeMemberFromSecurityLevel

public io.reactivex.Single<Object> removeMemberFromSecurityLevel(String schemeId,
                                                                 String levelId,
                                                                 String memberId,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove member from issue security level Removes an issue security level member from an issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme. (required)

levelId - The ID of the issue security level. (required)

memberId - The ID of the issue security level member to be removed. (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<Object>

searchProjectsUsingSecuritySchemes

public io.reactivex.Single<PageBeanIssueSecuritySchemeToProjectMapping> searchProjectsUsingSecuritySchemes(Optional<String> startAt,
                                                                                                           Optional<String> maxResults,
                                                                                                           Optional<List<String>> issueSecuritySchemeId,
                                                                                                           Optional<List<String>> projectId,
                                                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get projects using issue security schemes Returns a [paginated](#pagination) mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

issueSecuritySchemeId - The list of security scheme IDs to be filtered out. (optional, default to new ArrayList<>())

projectId - The list of project IDs to be filtered out. (optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Single<PageBeanIssueSecuritySchemeToProjectMapping>

searchSecuritySchemes

public io.reactivex.Single<PageBeanSecuritySchemeWithProjects> searchSecuritySchemes(Optional<String> startAt,
                                                                                     Optional<String> maxResults,
                                                                                     Optional<List<String>> id,
                                                                                     Optional<List<String>> projectId,
                                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search issue security schemes Returns a [paginated](#pagination) list of issue security schemes. If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use \\IssueSecuritySchemeResource\\#searchProjectsUsingSecuritySchemes(String, String, Set, Set)\\ to obtain all projects related to scheme. Only issue security schemes in the context of classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

id - The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: `id=10000&id=10001`. (optional, default to new ArrayList<>())

projectId - The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: `projectId=10000&projectId=10001`. (optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Single<PageBeanSecuritySchemeWithProjects>

setDefaultLevels

public io.reactivex.Single<Object> setDefaultLevels(Map<String,Object> requestBody,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set default issue security levels Sets default issue security levels for schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

updateIssueSecurityScheme

public io.reactivex.Single<Object> updateIssueSecurityScheme(String id,
                                                             UpdateIssueSecuritySchemeRequestBean updateIssueSecuritySchemeRequestBean,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update issue security scheme Updates the issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the issue security scheme. (required)

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

updateSecurityLevel

public io.reactivex.Single<Object> updateSecurityLevel(String schemeId,
                                                       String levelId,
                                                       Map<String,Object> requestBody,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update issue security level Updates the issue security level. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

schemeId - The ID of the issue security scheme level belongs to. (required)

levelId - The ID of the issue security level to update. (required)

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