com.xebialabs.deployit.engine.api

Interface RoleService

@Path(value="/security/role")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
public interface RoleService

Manages the roles in XL Deploy's security system.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(java.lang.String name, java.lang.String principal) Assigns a role to a user or group.
void	create(java.lang.String name) Creates a new role.
void	delete(java.lang.String name) Removes a role from the XL Deploy security system.
java.util.List<java.lang.String>	list() Lists the names of all available roles in the security system.
java.util.List<java.lang.String>	listMyRoles() Lists the roles of the currently logged in user.
java.util.List<java.lang.String>	listRoles(java.lang.String username) Lists the roles of a user.
void	rename(java.lang.String name, java.lang.String newName) Renames a role.
void	unassign(java.lang.String name, java.lang.String principal) Removes a role from a user or group.

Method Detail

list

@GET
java.util.List<java.lang.String> list()

Lists the names of all available roles in the security system.

Returns:

a list of role names.

listMyRoles

@GET
@Path(value="roles")
java.util.List<java.lang.String> listMyRoles()

Lists the roles of the currently logged in user.

Returns:

a list of role names.

listRoles

@GET
@Path(value="roles/{username}")
java.util.List<java.lang.String> listRoles(@PathParam(value="username")
                                                  java.lang.String username)

Lists the roles of a user.

Parameters:

username - the username of the principal

Returns:

a list of role names.

Permission:

security#edit

create

@PUT
@Path(value="{role}")
void create(@PathParam(value="role")
                   java.lang.String name)

Creates a new role. Does nothing if the role already exists.

Parameters:

name - the name of the new role.

Permission:

security#edit

assign

@PUT
@Path(value="{role}/{principal}")
void assign(@PathParam(value="role")
                   java.lang.String name,
                   @PathParam(value="principal")
                   java.lang.String principal)

Assigns a role to a user or group. The role will be created if it doesn't exist yet.

Parameters:

name - the name of the role to assign

principal - the user or group to assign the role to.

Permission:

security#edit

unassign

@DELETE
@Path(value="{role}/{principal}")
void unassign(@PathParam(value="role")
                        java.lang.String name,
                        @PathParam(value="principal")
                        java.lang.String principal)

Removes a role from a user or group.

Parameters:

name - the name of the role to remove

principal - the user or group to remove the role from.

Permission:

security#edit

rename

@POST
@Path(value="{role}")
void rename(@PathParam(value="role")
                    java.lang.String name,
                    java.lang.String newName)

Renames a role. Does nothing if the role does not exist.

Parameters:

name - the current name

newName - the new name

Permission:

security#edit

delete

@DELETE
@Path(value="{role}")
void delete(@PathParam(value="role")
                      java.lang.String name)

Removes a role from the XL Deploy security system. All assignments to principals are deleted as well.

Parameters:

name - the name of the role to delete.

Permission:

security#edit