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 |
paginate results Validations:
|
per_page Optional |
number of entries per request Validations:
|
Field name | Tipo | Possible values |
---|---|---|
admin | true, false | |
description | text | |
firstname | string | |
last_login_on | datetime | |
lastname | string | |
location | string | |
location_id | integer | |
login | string | |
string | ||
organization | string | |
organization_id | integer | |
role | string | |
role_id | integer | |
usergroup | string |
Param Name | Description |
---|---|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
id Required |
Validations:
|
Adds role 'Default role' to the user by default
Param Name | Description |
---|---|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
user Required |
Validations:
|
user[login] Required |
Validations:
|
user[firstname] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[lastname] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[mail] Required |
Validations:
|
user[description] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[admin] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
is an admin account Validations:
|
user[password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[default_organization_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[auth_source_id] Required |
Validations:
|
user[timezone] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
User's timezone Validations:
|
user[locale] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
User's preferred locale Validations:
|
user[role_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[location_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
user[organization_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
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 |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
id Required |
Validations:
|
user Required |
Validations:
|
user[login] Optional |
Validations:
|
user[firstname] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[lastname] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[mail] Optional |
Validations:
|
user[description] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[admin] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
is an admin account Validations:
|
user[password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[default_organization_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[auth_source_id] Optional |
Validations:
|
user[timezone] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
User's timezone Validations:
|
user[locale] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
User's preferred locale Validations:
|
user[role_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[location_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
user[organization_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE organizations with given ids. Validations:
|
user[current_password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Required when user want to change own password Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
id Required |
Validations:
|