PUT /api/users/:id
Update a user

Adds role ‘Default role’ to the user if it is not already present. Only another admin can change the admin account attribute.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
user
required

Validations:

  • Hash
user[login]
optional

Validations:

  • String
user[firstname]
optional , nil allowed

Validations:

  • String
user[lastname]
optional , nil allowed

Validations:

  • String
user[mail]
optional

Validations:

  • String
user[description]
optional , nil allowed

Validations:

  • String
user[disabled]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
user[admin]
optional , nil allowed

is an admin account

Validations:

  • Must be one of: true, false, 1, 0.
user[password]
optional , nil allowed

Required unless user is in an external authentication source

Validations:

  • String
user[default_location_id]
optional , nil allowed

Validations:

  • Integer
user[default_organization_id]
optional , nil allowed

Validations:

  • Integer
user[auth_source_id]
optional

Validations:

  • Integer
user[timezone]
optional , nil allowed

User’s timezone

Validations:

  • Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Chihuahua, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Greenland, Montevideo, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..
user[locale]
optional , nil allowed

User’s preferred locale

Validations:

  • Must be one of: cs_CZ, de, en, en_GB, es, fr, it, ja, ko, pt_BR, ru, zh_CN, zh_TW.
user[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
user[mail_enabled]
optional , nil allowed

Enable user’s email

Validations:

  • Must be one of: true, false, 1, 0.
user[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
user[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
user[current_password]
optional , nil allowed

Required when user want to change own password

Validations:

  • String