com.atlassian.bamboo.plugins.rest.admin.permission

Interface RestGlobalPermissionService

All Known Implementing Classes:

RestGlobalPermissionServiceImpl

public interface RestGlobalPermissionService

REST service layer to manage permissions

Since:

5.10

Method Summary

Modifier and Type	Method and Description
List<RestGlobalPermission>	getGroupPermissions(String groupName) Retrieve a list of groups with their permissions filtered by group name.
RestGlobalPermission	updateGroupPermission(RestGlobalPermission restGlobalPermission) Update permission of a group in bamboo.

Method Detail

getGroupPermissions

@NotNull
List<RestGlobalPermission> getGroupPermissions(@NotNull
                                                        String groupName)
                                                 throws WebValidationException

Retrieve a list of groups with their permissions filtered by group name. Currently only one group will be included in the list. Only Restricted Admins or System Admins can call this method. If current user is a Restricted Admin, he/she can only get groups with Restricted Admin or less permissions. If current user is a System Admin, he/she can get groups with any permissions.

Parameters:

groupName - Group name

Returns:

List of group permissions

Throws:

WebValidationException - If groupName is empty

updateGroupPermission

@NotNull
RestGlobalPermission updateGroupPermission(@Nullable
                                                    RestGlobalPermission restGlobalPermission)
                                             throws WebValidationException

Update permission of a group in bamboo. Only Restricted/System Admin is allowed to call this method. Restricted Admin cannot update System Admin Permissions. It also makes sure at lease one group or user with System Admin permission will be kept in bamboo.

Parameters:

restGlobalPermission - Permissions of the group

Throws:

WebValidationException - If parameter is invalid, e.g. name is empty, revoking SysAdmin permission from the last SysAdmin group.