org.everit.atlassian.restclient.jiracloud.v3.api

Class RoleApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.RoleApi

public class RoleApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ProjectRole>	addProjectRoleActorsToRole(Long id, ActorInputBean actorInputBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add default actors to project role Adds default actors to a role.
io.reactivex.Single<ProjectRole>	createProjectRole(CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create project role Creates a new project role with no default actors.
io.reactivex.Completable	deleteProjectRole(Long id, Optional<Long> swap, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project role Deletes a project role.
io.reactivex.Single<ProjectRole>	deleteProjectRoleActorsFromRole(Long id, Optional<String> user, Optional<String> group, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete default actors from project role Deletes the default actors from a project role.
io.reactivex.Single<ProjectRole>	fullyUpdateProjectRole(Long id, CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Fully update project role Updates the project role's name and description.
io.reactivex.Single<List<ProjectRole>>	getAllProjectRoles(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all project roles Gets a list of all project roles, complete with project role details and default actors.
io.reactivex.Single<ProjectRole>	getProjectRoleActorsForRole(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get default actors for project role Returns the default actors for the project role.
io.reactivex.Single<ProjectRole>	getProjectRoleById(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project role by ID Gets the project role details and the default actors associated with the role.
io.reactivex.Single<ProjectRole>	partialUpdateProjectRole(Long id, CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Partial update project role Updates either the project role's name or its description.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleApi

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

Method Detail

addProjectRoleActorsToRole

public io.reactivex.Single<ProjectRole> addProjectRoleActorsToRole(Long id,
                                                                   ActorInputBean actorInputBean,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add default actors to project role

Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.

Changing a project role's default actors does not affect project role members for projects already created.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role IDs.

(required)

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

createProjectRole

public io.reactivex.Single<ProjectRole> createProjectRole(CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create project role

Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.

Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.<

Permissions required: Administer Jira global permission.

Parameters:

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

deleteProjectRole

public io.reactivex.Completable deleteProjectRole(Long id,
                                                  Optional<Long> swap,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete project role

Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.

(required)

swap -

The ID of the project role that will replace the one being deleted.

(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

deleteProjectRoleActorsFromRole

public io.reactivex.Single<ProjectRole> deleteProjectRoleActorsFromRole(Long id,
                                                                        Optional<String> user,
                                                                        Optional<String> group,
                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete default actors from project role

Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.

Changing a project role's default actors does not affect project role members for projects already created.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role IDs.

(required)

user -

The user account ID of the user to remove as a default actor.

(optional)

group -

The group name of the group to be removed as a default actor.

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

fullyUpdateProjectRole

public io.reactivex.Single<ProjectRole> fullyUpdateProjectRole(Long id,
                                                               CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Fully update project role

Updates the project role's name and description. You must include both a name and a description in the request.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role IDs.

(required)

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

getAllProjectRoles

public io.reactivex.Single<List<ProjectRole>> getAllProjectRoles(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all project roles

Gets a list of all project roles, complete with project role details and default actors.

About project roles

Project roles are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).

Project roles are used in permission schemes, email notification schemes, issue security levels, comment visibility, and workflow conditions.

Members and actors

In the Jira REST API, a member of a project role is called an actor. An actor is a group or user associated with a project role.

Actors may be set as default members of the project role or set at the project level:

• Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
• Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.

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<List<ProjectRole>>

getProjectRoleActorsForRole

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

Get default actors for project role

Returns the default actors for the project role.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role 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<ProjectRole>

getProjectRoleById

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

Get project role by ID

Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role 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<ProjectRole>

partialUpdateProjectRole

public io.reactivex.Single<ProjectRole> partialUpdateProjectRole(Long id,
                                                                 CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Partial update project role

Updates either the project role's name or its description.

You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the project role. Use Get all project roles to get a list of project role IDs.

(required)

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