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:
|
search Optional |
filter results Validations:
|
order Optional |
sort results Validations:
|
page Optional |
paginate results Validations:
|
per_page Optional |
number of entries per request Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Adds role 'Anonymous' to the user by default
Param Name | Description |
---|---|
user Required |
Validations:
|
user[login] Required |
Validations:
|
user[firstname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[lastname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[mail] Required |
Validations:
|
user[admin] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
is an admin account Validations:
|
user[password] Required |
Validations:
|
user[auth_source_id] Required |
Validations:
|
user[timezone] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
User's timezone Validations:
|
user[locale] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
User's preferred locale Validations:
|
Adds role 'Anonymous' to the user if it is not already present. Only another admin can change the admin account attribute.
Param Name | Description |
---|---|
id Required |
Validations:
|
user Required |
Validations:
|
user[login] Optional |
Validations:
|
user[firstname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[lastname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
user[mail] Optional |
Validations:
|
user[admin] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
is an admin account Validations:
|
user[password] Optional |
Validations:
|
user[auth_source_id] Optional |
Validations:
|
user[timezone] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
User's timezone Validations:
|
user[locale] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
User's preferred locale Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|