User
/api/user endpoints.
DELETE /api/user/:id
Disable a User
. This does not remove the User
from the DB, but instead disables their account.
You must be a superuser to do this.
PARAMS:
id
GET /api/user/
Fetch a list of Users
. By default returns every active user but only active users.
- If
status
isdeactivated
, include deactivated users only. - If
status
isall
, include all users (active and inactive). - Also supports
include_deactivated
, which if true, is equivalent tostatus=all
; If is false, is equivalent tostatus=active
.status
andinclude_deactivated
requires superuser permissions. include_deactivated
is a legacy alias forstatus
and will be removed in a future release, users are advised to usestatus
for better support and flexibility. If both params are passed,status
takes precedence.
For users with segmented permissions, return only themselves.
Takes limit
, offset
for pagination.
Takes query
for filtering on first name, last name, email.
Also takes group_id
, which filters on group id.
PARAMS:
-
status
value may be nil, or if non-nil, value must be a string. -
query
value may be nil, or if non-nil, value must be a string. -
group_id
value may be nil, or if non-nil, value must be an integer greater than zero. -
include_deactivated
value may be nil, or if non-nil, value must be a valid boolean string (‘true’ or ‘false’).
GET /api/user/:id
Fetch a User
. You must be fetching yourself or be a superuser or a Group Manager.
PARAMS:
id
GET /api/user/current
Fetch the current User
.
POST /api/user/
Create a new User
, return a 400 if the email address is already taken.
You must be a superuser to do this.
PARAMS:
-
first_name
value may be nil, or if non-nil, value must be a non-blank string. -
last_name
value may be nil, or if non-nil, value must be a non-blank string. -
email
value must be a valid email address. -
user_group_memberships
value may be nil, or if non-nil, value must be an array. Each value must be a map with schema: ( is_group_manager (optional) : value must be a boolean. id : value must be an integer greater than zero. ) -
login_attributes
value may be nil, or if non-nil, login attribute keys must be a keyword or string
POST /api/user/:id/send_invite
Resend the user invite email for a given user.
You must be a superuser to do this.
PARAMS:
id
PUT /api/user/:id
Update an existing, active User
.
Self or superusers can update user info and groups.
Group Managers can only add/remove users from groups they are manager of.
PARAMS:
-
email
value may be nil, or if non-nil, value must be a valid email address. -
first_name
value may be nil, or if non-nil, value must be a non-blank string. -
is_group_manager
value may be nil, or if non-nil, value must be a boolean. -
locale
value may be nil, or if non-nil, String must be a valid two-letter ISO language or language-country code e.g. en or en_US. -
user_group_memberships
value may be nil, or if non-nil, value must be an array. Each value must be a map with schema: ( is_group_manager (optional) : value must be a boolean. id : value must be an integer greater than zero. ) -
id
-
is_superuser
value may be nil, or if non-nil, value must be a boolean. -
login_attributes
value may be nil, or if non-nil, login attribute keys must be a keyword or string -
last_name
value may be nil, or if non-nil, value must be a non-blank string.
PUT /api/user/:id/modal/:modal
Indicate that a user has been informed about the vast intricacies of ‘the’ Query Builder.
PARAMS:
-
id
-
modal
PUT /api/user/:id/password
Update a user’s password.
PARAMS:
-
id
-
password
password is too common. -
old_password
PUT /api/user/:id/reactivate
Reactivate user at :id
.
You must be a superuser to do this.
PARAMS:
id