Package com.xebialabs.deployit.engine.api

Interface UserService

@Path("/security/user") @Consumes({"application/xml","application/json"}) @Produces({"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 Details

    • create

      @POST @Path("{username}") User create(@PathParam("username") 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("{username}") User read(@PathParam("username") 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 List<String> listUserNames(@QueryParam("username") String username, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("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("{username}") void modifyPassword(@PathParam("username") 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

    • validatePassword

      @POST @Path("validatePassword") List<PasswordValidationResult> validatePassword(User user)

    • delete

      @DELETE @Path("{username}") void delete(@PathParam("username") String username)
      Deletes the user.
      Parameters:
      username - the login name of the user.
      Permission:
      security#edit