PermissionsResource (Atlassian Bamboo 6.10.6 API)

All Known Implementing Classes:

DeploymentProjectPermissionsResource, EnvironmentPermissionsResource, GlobalPermissionsResource, PlanPermissionsResource, ProjectPermissionsResource, ProjectPlanPermissionsResource, RepositoryPermissionsResource
```
public interface PermissionsResource
```
Defines common API for permissions resources

Field Summary

Fields
Modifier and Type Field and Description

static String ROLE_ANONYMOUS

static String ROLE_LOGGED_IN

Fields
Modifier and Type	Field and Description
`static String`	`ROLE_ANONYMOUS`
`static String`	`ROLE_LOGGED_IN`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addPermissionsForGroup(String key, String group, List<String> permissionsToAdd)` Adds given permissions to group Returns status code 204 `Response.Status#NO_CONTENT` if any permission was added or status code 304 `Response.Status#NOT_MODIFIED` if given permissions were already added
`javax.ws.rs.core.Response`	`addPermissionsForRole(String key, String role, List<String> permissionsToAdd)` Adds given permissions to role Returns status code 204 `Response.Status#NO_CONTENT` if any permission was added or status code 304 `Response.Status#NOT_MODIFIED` if all permissions were already added
`javax.ws.rs.core.Response`	`addPermissionsForUser(String key, String username, List<String> permissionsToAdd)` Adds given permissions to user Returns status code 204 `Response.Status#NO_CONTENT` if any permission was added or status code 304 `Response.Status#NOT_MODIFIED` if given permissions were already added
`RestPageModel<RestGroup>`	`getAvailableGroups(String key, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)` Returns a paged list of groups `RestGroup` for which no permissions was defined.
`RestPageModel<RestUser>`	`getAvailableUsers(String key, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)` Returns a paged list of users `RestUser` for which no permissions was defined.
`RestPageModel<RestGroupPermission>`	`listGroupPermissions(String key, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)` Returns a paged list of groups `RestGroupPermission` with non empty permissions
`RestPageModel<RestRolePermission>`	`listRolePermissions(String key, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)` Returns a paged list of roles `RestRolePermission` with non empty permissions
`RestPageModel<RestUserPermission>`	`listUserPermissions(String key, String nameFilter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)` Returns a paged list of users `RestUserPermission` with non empty permissions
`javax.ws.rs.core.Response`	`removePermissionsForGroup(String key, String group, List<String> permissionsToRemove)` Removes given permissions from group Returns status code 204 `Response.Status#NO_CONTENT` if any permission was removed or status code 304 `Response.Status#NOT_MODIFIED` if given permissions were not present
`javax.ws.rs.core.Response`	`removePermissionsForRole(String key, String role, List<String> permissionsToRemove)` Removes given permissions from role Returns status code 204 `Response.Status#NO_CONTENT` if any permission was removed or status code 304 `Response.Status#NOT_MODIFIED` if given permissions were not present
`javax.ws.rs.core.Response`	`removePermissionsForUser(String key, String username, List<String> permissionsToRemove)` Removes given permissions from user Returns status code 204 `Response.Status#NO_CONTENT` if any permission was removed or status code 304 `Response.Status#NOT_MODIFIED` if given permissions were not present

Field Detail
- ROLE_ANONYMOUS
```
static final String ROLE_ANONYMOUS
```
  See Also:
  
  Constant Field Values
- ROLE_LOGGED_IN
```
static final String ROLE_LOGGED_IN
```
  See Also:
  
  Constant Field Values

Method Detail

listUserPermissions

RestPageModel<RestUserPermission> listUserPermissions(String key,
                                                      String nameFilter,
                                                      PageRequest pageRequest,
                                                      Expansion expansion,
                                                      javax.ws.rs.core.UriInfo uriInfo)

Returns a paged list of users RestUserPermission with non empty permissions

addPermissionsForUser

javax.ws.rs.core.Response addPermissionsForUser(String key,
                                                String username,
                                                List<String> permissionsToAdd)

Adds given permissions to user Returns status code 204 Response.Status#NO_CONTENT if any permission was added or status code 304 Response.Status#NOT_MODIFIED if given permissions were already added

removePermissionsForUser

javax.ws.rs.core.Response removePermissionsForUser(String key,
                                                   String username,
                                                   List<String> permissionsToRemove)

Removes given permissions from user Returns status code 204 Response.Status#NO_CONTENT if any permission was removed or status code 304 Response.Status#NOT_MODIFIED if given permissions were not present

getAvailableUsers

RestPageModel<RestUser> getAvailableUsers(String key,
                                          String nameFilter,
                                          PageRequest pageRequest,
                                          Expansion expansion,
                                          javax.ws.rs.core.UriInfo uriInfo)

Returns a paged list of users RestUser for which no permissions was defined. Allows to filter by user name

listGroupPermissions

RestPageModel<RestGroupPermission> listGroupPermissions(String key,
                                                        String nameFilter,
                                                        PageRequest pageRequest,
                                                        Expansion expansion,
                                                        javax.ws.rs.core.UriInfo uriInfo)

Returns a paged list of groups RestGroupPermission with non empty permissions

addPermissionsForGroup

javax.ws.rs.core.Response addPermissionsForGroup(String key,
                                                 String group,
                                                 List<String> permissionsToAdd)

Adds given permissions to group Returns status code 204 Response.Status#NO_CONTENT if any permission was added or status code 304 Response.Status#NOT_MODIFIED if given permissions were already added

removePermissionsForGroup

javax.ws.rs.core.Response removePermissionsForGroup(String key,
                                                    String group,
                                                    List<String> permissionsToRemove)

Removes given permissions from group Returns status code 204 Response.Status#NO_CONTENT if any permission was removed or status code 304 Response.Status#NOT_MODIFIED if given permissions were not present

getAvailableGroups

RestPageModel<RestGroup> getAvailableGroups(String key,
                                            String nameFilter,
                                            PageRequest pageRequest,
                                            Expansion expansion,
                                            javax.ws.rs.core.UriInfo uriInfo)

Returns a paged list of groups RestGroup for which no permissions was defined. Allows to filter by group name

listRolePermissions

RestPageModel<RestRolePermission> listRolePermissions(String key,
                                                      PageRequest pageRequest,
                                                      Expansion expansion,
                                                      javax.ws.rs.core.UriInfo uriInfo)

Returns a paged list of roles RestRolePermission with non empty permissions

addPermissionsForRole

javax.ws.rs.core.Response addPermissionsForRole(String key,
                                                String role,
                                                List<String> permissionsToAdd)

Adds given permissions to role Returns status code 204 Response.Status#NO_CONTENT if any permission was added or status code 304 Response.Status#NOT_MODIFIED if all permissions were already added

removePermissionsForRole

javax.ws.rs.core.Response removePermissionsForRole(String key,
                                                   String role,
                                                   List<String> permissionsToRemove)

Removes given permissions from role Returns status code 204 Response.Status#NO_CONTENT if any permission was removed or status code 304 Response.Status#NOT_MODIFIED if given permissions were not present

Interface PermissionsResource

Field Summary