UsersApi

Create a User Adds new application user. Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete). Mandatory Fields: username, firstname, lastname, email, officeId, roles, sendPasswordToEmail Optional Fields: staffId,passwordNeverExpires,isSelfServiceUser,clients Responses:

Delete a User Removes the user and the associated roles and permissions. Responses:

Responses:

Responses:

Retrieve list of users Example Requests: users users?fields=id,username,email,officeName Responses:

Retrieve a User Example Requests: users/1 users/1?template=true users/1?fields=username,officeName Responses:

Retrieve User Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: users/template Responses:

Update a User When updating a password you must provide the repeatPassword parameter also. Responses: