userDelta

ccc.rest.dto.UserDto userDelta(java.util.UUID userId)
                               throws RestException

Retrieve the delta for a user.

 

Parameters:

userId - The user's id.

Returns:

The corresponding delta.

Throws:

RestException - If the method fails

loggedInUser

ccc.rest.dto.UserDto loggedInUser()

Returns currently logged in user.

 

Returns:

UserDTO

listUsers

java.util.Collection<ccc.rest.dto.UserDto> listUsers()

Query all users.

 

Returns:

Returns list of users.

listUsersWithRole

java.util.Collection<ccc.rest.dto.UserDto> listUsersWithRole(java.lang.String role)

Query users with specified role.

 

Parameters:

role - The role as a string.

Returns:

Returns list of users.

listUsersWithUsername

java.util.Collection<ccc.rest.dto.UserDto> listUsersWithUsername(ccc.types.Username username)

Query users with specified username.

 

Parameters:

username - The username.

Returns:

Returns list of users.

usernameExists

java.lang.Boolean usernameExists(ccc.types.Username username)

Query whether the specified username is in use.

 

Parameters:

username - The username to check

Returns:

True if the username is in use, false otherwise.

listUsersWithEmail

java.util.Collection<ccc.rest.dto.UserDto> listUsersWithEmail(java.lang.String email)

Query users with specified email.

 

Parameters:

email - The email as a string.

Returns:

Returns list of users.

createUser

ccc.rest.dto.UserDto createUser(ccc.rest.dto.UserDto delta)
                                throws RestException

Create a new user in the system.

 

Parameters:

delta - The new user details.

Returns:

A user summary describing the new user.

Throws:

RestException - If the method fails.

updateUser

void updateUser(java.util.UUID userId,
                ccc.rest.dto.UserDto delta)
                throws RestException

Updates the user in the system.

 

Parameters:

userId - The id of the user to update.

delta - The changes to apply.

Throws:

RestException - If the method fails.

updateUserPassword

void updateUserPassword(java.util.UUID userId,
                        ccc.rest.dto.UserDto user)
                        throws RestException

Update the password for the specified user.

 

Parameters:

userId - The user's id.

user - New details for the user.

Throws:

RestException - If the method fails.

updateYourUser

void updateYourUser(java.util.UUID userId,
                    ccc.rest.dto.UserDto user)
                    throws RestException

Update the email and/or password for the current user.

 

Parameters:

userId - The user's id.

user - New details for the user.

Throws:

RestException - If the method fails.

userByLegacyId

ccc.rest.dto.UserDto userByLegacyId(java.lang.String legacyId)
                                    throws RestException

Look up the user for a specified legacy id.

 

Parameters:

legacyId - The legacy id of the user.

Returns:

A summary of the corresponding user.

Throws:

RestException - If the method fails

listUserMetadataValuesWithKey

java.util.Collection<java.lang.String> listUserMetadataValuesWithKey(java.lang.String key)

Query metadata values with given key.

 

Parameters:

key - The key as a string.

Returns:

Returns list of users.