User

User management.

Find

Find matching users.

Endpoint

POST /user/find

Authorized User Role

user

Request Body

Field	Type	Role	Notes
email	string	admin	Email address.
id	string	admin	User ID.

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Paged response.

Field	Type	Notes
data	array	An array of User records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

User

Field	Type	Notes
accountId	string	Owning account ID.
activity	date	User activity date.
email	string	User email address.
first	string	User first name.
id	string	User ID.
invite	string	Invite code.
last	string	User last name.
preferences	object	User preferences.
role	string	User role.
state	string	User state.

Get

Get a user by ID.

Endpoint

POST /user/get

Authorized User Role

user

Request Body

Field	Type	Role	Notes
email	string	admin	Email address.
id	string	admin	User ID.

Response

User Record.

Field	Type	Notes
accountId	string	Owning account ID.
activity	date	User activity date.
email	string	User email address.
first	string	User first name.
id	string	User ID.
invite	string	Invite code.
last	string	User last name.
preferences	object	User preferences.
role	string	User role.
state	string	User state.

Login

Login the authenticated user.

Endpoint

POST /user/login

Authorized User Role

public

Request Body

Field	Type	Notes
invite	string	Invite code.
register	boolean	Register.

Response

A user object.

Field	Type	Notes
account	object	Account object.
user	object	User object.

Remove

Remove a user.

Endpoint

POST /user/remove

Authorized User Role

admin

Request Body

Field	Type	Notes
email	string	Email address.
id	string	User ID.

Update

Update a user.

Endpoint

POST /user/update

Authorized User Role

user

Request Body

Field	Type	Notes
email	string	Email address.
first	string	First name.
id	string	User ID.
last	string	Last name.
preferences	object	Preferences.

Response

User Record.

Field	Type	Notes
accountId	string	Owning account ID.
activity	date	User activity date.
email	string	User email address.
first	string	User first name.
id	string	User ID.
invite	string	Invite code.
last	string	User last name.
preferences	object	User preferences.
role	string	User role.
state	string	User state.

UpdateRole

Update a user role.

Endpoint

POST /user/updateRole

Authorized User Role

admin

Request Body

Field	Type	Role	Notes
id	string		User ID.
role	string	admin	Authorized role.
sendInvite	boolean		Send invite email.

Response

User Record.

Field	Type	Notes
accountId	string	Owning account ID.
activity	date	User activity date.
email	string	User email address.
first	string	User first name.
id	string	User ID.
invite	string	Invite code.
last	string	User last name.
preferences	object	User preferences.
role	string	User role.
state	string	User state.