Param name | Description |
---|---|
auth_source_ldap_id optional |
ID of LDAP authentication source Validations:
|
usergroup_id optional |
ID of user group Validations:
|
role_id optional |
ID of role Validations:
|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return Validations:
|
Field name | Tipo | Possible values |
---|---|---|
admin | true, false | |
auth_source | ||
auth_source_type | ||
description | ||
firstname | ||
last_login_on | ||
lastname | ||
location | ||
location_id | ||
login | ||
organization | ||
organization_id | ||
role | ||
role_id | ||
usergroup |
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
Adds role 'Default role' to the user by default
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
user required |
Validations:
|
user[login] required |
Validations:
|
user[firstname] optional , nil allowed |
Validations:
|
user[lastname] optional , nil allowed |
Validations:
|
user[mail] required |
Validations:
|
user[description] optional , nil allowed |
Validations:
|
user[admin] optional , nil allowed |
is an admin account Validations:
|
user[password] optional , nil allowed |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] optional , nil allowed |
Validations:
|
user[default_organization_id] optional , nil allowed |
Validations:
|
user[auth_source_id] required |
Validations:
|
user[timezone] optional , nil allowed |
User's timezone Validations:
|
user[locale] optional , nil allowed |
User's preferred locale Validations:
|
user[role_ids] optional , nil allowed |
Validations:
|
user[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
user[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
user required |
Validations:
|
user[login] optional |
Validations:
|
user[firstname] optional , nil allowed |
Validations:
|
user[lastname] optional , nil allowed |
Validations:
|
user[mail] optional |
Validations:
|
user[description] optional , nil allowed |
Validations:
|
user[admin] optional , nil allowed |
is an admin account Validations:
|
user[password] optional , nil allowed |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] optional , nil allowed |
Validations:
|
user[default_organization_id] optional , nil allowed |
Validations:
|
user[auth_source_id] optional |
Validations:
|
user[timezone] optional , nil allowed |
User's timezone Validations:
|
user[locale] optional , nil allowed |
User's preferred locale Validations:
|
user[role_ids] optional , nil allowed |
Validations:
|
user[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
user[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
user[current_password] optional , nil allowed |
Required when user want to change own password Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|