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.

Examples

PUT /api/users/988725687
{
  "user": {
    "mail": "john@example.com",
    "auth_source_id": {
      "auth_source_internal": {
        "id": 200482051,
        "name": "Internal",
        "host": null,
        "port": null,
        "account": null,
        "account_password": null,
        "base_dn": null,
        "attr_login": null,
        "attr_firstname": null,
        "attr_lastname": null,
        "attr_mail": null,
        "onthefly_register": false,
        "tls": false,
        "created_at": "2019-11-07T08:36:55.274Z",
        "updated_at": "2019-11-07T08:36:55.274Z",
        "ldap_filter": null,
        "attr_photo": null,
        "server_type": "posix",
        "groups_base": null,
        "usergroup_sync": true,
        "use_netgroups": false
      }
    },
    "password": "123456"
  }
}
200
{
  "firstname": null,
  "lastname": null,
  "mail": "john@example.com",
  "admin": false,
  "auth_source_id": 980190962,
  "auth_source_name": "ldap-server",
  "timezone": null,
  "locale": null,
  "last_login_on": null,
  "created_at": "2019-11-07 08:37:05 UTC",
  "updated_at": "2019-11-07 08:37:05 UTC",
  "id": 988725687,
  "login": "foo",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [],
  "default_organization": null,
  "organizations": [],
  "effective_admin": false,
  "cached_usergroups": [],
  "auth_source_ldap": {
    "id": 980190962,
    "type": "AuthSourceLdap",
    "name": "ldap-server"
  },
  "mail_notifications": [],
  "roles": [],
  "usergroups": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
user
required

Validations:

  • Must be a Hash
user[login]
optional

Validations:

  • Must be a String
user[firstname]
optional , nil allowed

Validations:

  • Must be a String
user[lastname]
optional , nil allowed

Validations:

  • Must be a String
user[mail]
optional

Validations:

  • Must be a String
user[description]
optional , nil allowed

Validations:

  • Must be a String
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:

  • Must be a String
user[default_location_id]
optional , nil allowed

Validations:

  • Must be a Integer
user[default_organization_id]
optional , nil allowed

Validations:

  • Must be a Integer
user[auth_source_id]
optional

Validations:

  • Must be a 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: ca, cs_CZ, de, en, en_GB, es, fr, gl, it, ja, ko, nl_NL, pl, pt_BR, ru, sv_SE, zh_CN, zh_TW.
user[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
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:

  • Must be a String