Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.
PUT /api/users/980190962 { "user": { "mail": "yUuAliGicP@example.com" } } 200 { "firstname": "One", "lastname": "User", "mail": "yUuAliGicP@example.com", "admin": false, "auth_source_id": 980190962, "auth_source_name": "ldap-server", "timezone": null, "locale": null, "last_login_on": "2009-10-12 21:50:04 UTC", "created_at": "2018-11-16 10:02:08 UTC", "updated_at": "2018-11-16 10:03:11 UTC", "id": 980190962, "login": "one", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "default_organization": null, "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ], "effective_admin": false, "cached_usergroups": [], "auth_source_ldap": { "id": 980190962, "type": "AuthSourceLdap", "name": "ldap-server" }, "mail_notifications": [], "roles": [ { "name": "Viewer", "id": 5, "description": null, "origin": "foreman" } ], "usergroups": [] }
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[disabled] 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[mail_enabled] optional , nil allowed |
Enable user's email 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:
|