com.xebialabs.deployit.engine.api

Interface UserService

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

Manages users in XL Deploy's internal user repository. Use this service only if you're not connected to an external user repository like LDAP.

Method Summary

Modifier and Type	Method and Description
User	create(java.lang.String username, User user) Creates a new user.
void	delete(java.lang.String username) Deletes the user.
java.util.List<java.lang.String>	listUserNames(java.lang.String username, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order) Returns the user details without the password.
void	modifyPassword(java.lang.String username, User user) Changes the password of the indicated user.
User	read(java.lang.String username) Returns the user details without the password.

Method Detail

create

@POST
 @Path(value="{username}")
User create(@PathParam(value="username")
                                             java.lang.String username,
                                             User user)

Creates a new user.

Parameters:

username - the login name

user - the details of the user, containing username and new password. Username in here should be the same as the username in the URL path.

Returns:

the created user, without the password.

Permission:

security#edit

read

@GET
 @Path(value="{username}")
User read(@PathParam(value="username")
                                          java.lang.String username)

Returns the user details without the password.

Parameters:

username - the login name of the user.

Returns:

the details of the user.

Permission:

security#edit

listUserNames

@GET
java.util.List<java.lang.String> listUserNames(@QueryParam(value="username")
                                                    java.lang.String username,
                                                    @BeanParam
                                                    com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                    @QueryParam(value="order")
                                                    com.xebialabs.deployit.engine.api.dto.Ordering order)

Returns the user details without the password.

Returns:

the details of the user.

Permission:

security#edit

modifyPassword

@PUT
 @Path(value="{username}")
void modifyPassword(@PathParam(value="username")
                                                    java.lang.String username,
                                                    User user)

Changes the password of the indicated user.

Parameters:

username - the login name of the user.

user - the details of the user, containing username and new password.

RestDetails:

Username should be the same as the username in the URL path.

Permission:

security#edit

delete

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

Deletes the user.

Parameters:

username - the login name of the user.

Permission:

security#edit