public class PlanPermissionsResource extends Object implements PermissionsResource
ROLE_ANONYMOUS, ROLE_LOGGED_IN
Modifier and Type | Method and Description |
---|---|
boolean |
addAnonymousPermissions(String key) |
boolean |
addGroupPermissions(String planKey,
String group,
List<BambooPermission> permissionsToAdd) |
boolean |
addLoggedInPermissions(String planKey,
List<BambooPermission> permissionsToAdd) |
javax.ws.rs.core.Response |
addPermissionsForGroup(String planKey,
String group,
List<String> permissionsToAdd)
Grants plan permissions to a given group.
|
javax.ws.rs.core.Response |
addPermissionsForRole(String planKey,
String role,
List<String> permissionsToAdd)
Grants plan permissions to a given role.
|
javax.ws.rs.core.Response |
addPermissionsForUser(String planKey,
String username,
List<String> permissionsToAdd)
Grants plan permissions to a given user.
|
boolean |
addUserPermissions(String planKey,
String username,
List<BambooPermission> permissionsToAdd) |
List<BambooPermission> |
getAnonymousPermissions(String planKey) |
RestPageModel<RestGroup> |
getAvailableGroups(String planKey,
String nameFilter,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Returns list of groups which weren't granted explicitly any plan permissions.
|
RestPageModel<RestUser> |
getAvailableUsers(String planKey,
String nameFilter,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Returns list of users which weren't granted explicitly any plan permissions.
|
List<BambooPermission> |
getGroupPermissions(String planKey,
String group) |
List<BambooPermission> |
getLoggedInPermissions(String planKey) |
List<BambooPermission> |
getUserPermissions(String planKey,
String username) |
RestPageModel<RestGroupPermission> |
listGroupPermissions(String planKey,
String nameFilter,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieve a list of groups with their plan permissions.
|
Iterable<String> |
listGroupsWithPermissions(String planKey) |
RestPageModel<RestRolePermission> |
listRolePermissions(String planKey,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieve a list of roles with their plan permissions.
|
RestPageModel<RestUserPermission> |
listUserPermissions(String planKey,
String nameFilter,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieve a list of users with their explicit permissions to given resource.
|
Iterable<String> |
listUsersWithPermissions(String planKey) |
boolean |
removeAnonymousPermissions(String key) |
boolean |
removeGroupPermissions(String planKey,
String group,
List<BambooPermission> permissionsToRemove) |
boolean |
removeLoggedInPermissions(String planKey,
List<BambooPermission> permissionsToRemove) |
javax.ws.rs.core.Response |
removePermissionsForGroup(String planKey,
String group,
List<String> permissionsToRemove)
Revokes plan permissions from a given group.
|
javax.ws.rs.core.Response |
removePermissionsForRole(String planKey,
String role,
List<String> permissionsToRemove)
Revokes plan permissions from a given role.
|
javax.ws.rs.core.Response |
removePermissionsForUser(String planKey,
String username,
List<String> permissionsToRemove)
Revokes plan permissions from a given user.
|
boolean |
removeUserPermissions(String planKey,
String username,
List<BambooPermission> permissionsToRemove) |
Collection<BambooPermission> |
supportedPermissions() |
Set<String> |
supportedRoles() |
public RestPageModel<RestUserPermission> listUserPermissions(String planKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
listUserPermissions
in interface PermissionsResource
planKey
- plan entity keynameFilter
- user filter, filter is case insensitive matches: username, user's full name, user's emailpageRequest
- represents the params that define which page the request is afterexpansion
- ignoreduriInfo
- ignoredpublic javax.ws.rs.core.Response addPermissionsForUser(String planKey, String username, List<String> permissionsToAdd)
addPermissionsForUser
in interface PermissionsResource
planKey
- plan entity keyusername
- username of the affected userpermissionsToAdd
- permission names to grantpublic javax.ws.rs.core.Response removePermissionsForUser(String planKey, String username, List<String> permissionsToRemove)
removePermissionsForUser
in interface PermissionsResource
planKey
- plan entity keyusername
- username of the affected userpermissionsToRemove
- permission names to be revokedpublic RestPageModel<RestUser> getAvailableUsers(String planKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
getAvailableUsers
in interface PermissionsResource
planKey
- plan entity keynameFilter
- user filter, filter is case insensitive matches: username, user's full name, user's emailpageRequest
- represents the params that define which page the request is afterexpansion
- ignoreduriInfo
- ignoredpublic RestPageModel<RestGroupPermission> listGroupPermissions(String planKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
listGroupPermissions
in interface PermissionsResource
planKey
- plan entity keynameFilter
- group name filter, filter is case insensitive matches group namepageRequest
- represents the params that define which page the request is afterexpansion
- ignoreduriInfo
- ignoredpublic javax.ws.rs.core.Response addPermissionsForGroup(String planKey, String group, List<String> permissionsToAdd)
addPermissionsForGroup
in interface PermissionsResource
planKey
- plan entity keygroup
- affected grouppermissionsToAdd
- permission names to grantpublic javax.ws.rs.core.Response removePermissionsForGroup(String planKey, String group, List<String> permissionsToRemove)
removePermissionsForGroup
in interface PermissionsResource
planKey
- plan entity keygroup
- affected grouppermissionsToRemove
- permission names to be revokedpublic RestPageModel<RestGroup> getAvailableGroups(String planKey, String nameFilter, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
getAvailableGroups
in interface PermissionsResource
planKey
- plan entity keynameFilter
- group name filter, filter is case insensitive matches group namepageRequest
- represents the params that define which page the request is afterexpansion
- ignoreduriInfo
- ignoredpublic RestPageModel<RestRolePermission> listRolePermissions(String planKey, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo)
listRolePermissions
in interface PermissionsResource
planKey
- plan entity keypageRequest
- represents the params that define which page the request is afterexpansion
- ignoreduriInfo
- ignoredpublic javax.ws.rs.core.Response addPermissionsForRole(String planKey, String role, List<String> permissionsToAdd)
addPermissionsForRole
in interface PermissionsResource
planKey
- plan entity keyrole
- affected rolepermissionsToAdd
- permission names to grantpublic javax.ws.rs.core.Response removePermissionsForRole(String planKey, String role, List<String> permissionsToRemove)
removePermissionsForRole
in interface PermissionsResource
planKey
- plan entity keyrole
- affected rolepermissionsToRemove
- permission names to be revokedpublic Collection<BambooPermission> supportedPermissions()
public List<BambooPermission> getUserPermissions(String planKey, String username)
public boolean addUserPermissions(String planKey, String username, List<BambooPermission> permissionsToAdd)
public boolean removeUserPermissions(String planKey, String username, List<BambooPermission> permissionsToRemove)
public List<BambooPermission> getGroupPermissions(String planKey, String group)
public boolean addGroupPermissions(String planKey, String group, List<BambooPermission> permissionsToAdd)
public boolean removeGroupPermissions(String planKey, String group, List<BambooPermission> permissionsToRemove)
public List<BambooPermission> getLoggedInPermissions(String planKey)
public boolean addLoggedInPermissions(String planKey, List<BambooPermission> permissionsToAdd)
public boolean removeLoggedInPermissions(String planKey, List<BambooPermission> permissionsToRemove)
public List<BambooPermission> getAnonymousPermissions(String planKey)
public boolean addAnonymousPermissions(String key)
public boolean removeAnonymousPermissions(String key)
Copyright © 2020 Atlassian Software Systems Pty Ltd. All rights reserved.