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

Class ProjectRoleApi

java.lang.Object

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

public class ProjectRoleApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ProjectRole>	addActorUsers(String projectIdOrKey, Long id, ActorsMap actorsMap, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add actors to project role Adds actors to a project role for the project.
io.reactivex.Completable	deleteActor(String projectIdOrKey, Long id, Optional<String> user, Optional<String> group, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete actors from project role Deletes actors from a project role for the project.
io.reactivex.Single<ProjectRole>	getProjectRole(String projectIdOrKey, Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project role for project Returns a project role's details and actors associated with the project.
io.reactivex.Single<Map<String,URI>>	getProjectRoles(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project roles for project Returns a list of project roles for the project returning the name and self URL for each role.
io.reactivex.Single<ProjectRole>	setActors(String projectIdOrKey, Long id, ProjectRoleActorsUpdateBean projectRoleActorsUpdateBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set actors for project role Sets the actors for a project role for a project, replacing all existing actors.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRoleApi

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

Method Detail

addActorUsers

public io.reactivex.Single<ProjectRole> addActorUsers(String projectIdOrKey,
                                                      Long id,
                                                      ActorsMap actorsMap,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add actors to project role

Adds actors to a project role for the project.

To replace all actors for the project, use Set actors for project role.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

id -

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

(required)

actorsMap -

The groups or users to associate with the project role for this project. Provide the user account ID or group name.

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

deleteActor

public io.reactivex.Completable deleteActor(String projectIdOrKey,
                                            Long id,
                                            Optional<String> user,
                                            Optional<String> group,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete actors from project role

Deletes actors from a project role for the project.

To remove default actors from the project role, use Delete default actors from project role This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

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 from the project role.

(optional)

group -

The name of the group to remove from the project role.

(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

getProjectRole

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

Get project role for project

Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

To check whether a user belongs to a role based on their group memberships, use Get user with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

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>

getProjectRoles

public io.reactivex.Single<Map<String,URI>> getProjectRoles(String projectIdOrKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project roles for project

Returns a list of project roles for the project returning the name and self URL for each role.

Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for any project on the siteAdminister Jira or global permission.

Parameters:

projectIdOrKey -

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<Map<String, URI>>

setActors

public io.reactivex.Single<ProjectRole> setActors(String projectIdOrKey,
                                                  Long id,
                                                  ProjectRoleActorsUpdateBean projectRoleActorsUpdateBean,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set actors for project role

Sets the actors for a project role for a project, replacing all existing actors.

To add actors to the project without overwriting the existing list, use Add actors to project role.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

id -

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

(required)

projectRoleActorsUpdateBean -

The groups or users to associate with the project role for this project. Provide the user account ID or group name.

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