Method Detail

• createUser

  @Named(value="createUser")
  @GET
  @Consumes(value="application/json")
  User createUser(@QueryParam(value="username")
                                   String userName,
                                   @QueryParam(value="account")
                                   String accountName,
                                   @QueryParam(value="email")
                                   String email,
                                   @QueryParam(value="password")
                                   String hashedPassword,
                                   @QueryParam(value="firstname")
                                   String firstName,
                                   @QueryParam(value="lastname")
                                   String lastName,
                                   CreateUserOptions... options)

  Create an user for an account that already exists

  Parameters:

  userName - unique user name

  accountName - Creates the user under the specified account. If no account is specified, the username will be used as the account name.

  email -

  hashedPassword - Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.

  firstName -

  lastName -

  options - optional arguments

  Returns:

• registerUserKeys

  @Named(value="registerUserKeys")
  @GET
  @Consumes(value="application/json")
  ApiKeyPair registerUserKeys(@QueryParam(value="id")
                                               String userId)

  This command allows a user to register for the developer API, returning a secret key and an API key

  Parameters:

  userId - the ID of the user

  Returns:

• updateUser

  @Named(value="updateUser")
  @GET
  @Consumes(value="application/json")
  User updateUser(@QueryParam(value="id")
                                   String id,
                                   UpdateUserOptions... options)

  Update an user

  Parameters:

  id - the user ID

  options - optional arguments

  Returns:

• deleteUser

  @Named(value="deleteUser")
  @GET
  @Consumes(value="application/json")
  void deleteUser(@QueryParam(value="id")
                                   String id)

  Delete an user with the specified ID

  Parameters:

  id - user ID