Skip to content

User

User management.


Create

Create a new user

Endpoint

1
POST /user/create

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
email string yes
role string yes
sendInvite boolean

Response

A user object.


Get

Endpoint

1
POST /user/get

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
email string
id string

Find

Endpoint

1
POST /user/find

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
email string
id string

Remove

Endpoint

1
POST /user/remove

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
email string
id string

Update

Update a user identity

Endpoint

1
POST /user/update

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
email string
first string
id string
last string
preferences object

Response

The user object.


UpdateRole

Endpoint

1
POST /user/updateRole

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
id string
role string
sendInvite boolean

Login

Login the authenticated user

Endpoint

1
POST /user/login

Authorized Role

1
anyone

Response

A user object.