POST /api/users
Create a user

Adds role ‘Default role’ to the user by default

Examples

POST /api/users
{
  "user": {
    "login": "foo",
    "auth_source_id": 200482051,
    "password": "123456",
    "role_ids": [
      1
    ],
    "organization_ids": [
      447626441
    ],
    "location_ids": [
      447626442
    ]
  }
}
201
{
  "firstname": null,
  "lastname": null,
  "mail": null,
  "admin": false,
  "auth_source_id": 200482051,
  "disabled": false,
  "auth_source_name": "Internal",
  "timezone": null,
  "locale": null,
  "last_login_on": null,
  "created_at": "2021-11-26 09:30:03 UTC",
  "updated_at": "2021-11-26 09:30:03 UTC",
  "id": 988725681,
  "login": "foo",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [
    {
      "id": 447626442,
      "name": "loc381",
      "title": "loc381",
      "description": null
    }
  ],
  "default_organization": null,
  "organizations": [
    {
      "id": 447626441,
      "name": "org351",
      "title": "org351",
      "description": null
    }
  ],
  "effective_admin": false,
  "cached_usergroups": [],
  "auth_source_internal": {
    "id": 200482051,
    "type": "AuthSourceInternal",
    "name": "Internal"
  },
  "mail_notifications": [],
  "roles": [
    {
      "name": "Manager",
      "id": 1,
      "description": null,
      "origin": "foreman"
    }
  ],
  "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
user
required

Validations:

  • Must be a Hash
user[login]
required

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]
required

Validations:

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

Validations:

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

  • 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]
required

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, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Volgograd, 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, ca, gl, nl_NL, pl, sv_SE.
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