GET /api/users
List all users

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
List all users for LDAP authentication source

GET /api/usergroups/:usergroup_id/users
List all users for user group

GET /api/roles/:role_id/users
List all users for role

GET /api/locations/:location_id/users
List all users for location

GET /api/organizations/:organization_id/users
List all users for organization

Params

Param name Description
auth_source_ldap_id
optional

ID of LDAP authentication source

Validations:

  • String

usergroup_id
optional

ID of user group

Validations:

  • String

role_id
optional

ID of role

Validations:

  • String

location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


GET /api/users/:id
Show a user

Params

Param name Description
id
required

Validations:

  • String


POST /api/users
Create a user

Adds role ‘Default role’ to the user by default

Params

Param name Description
user
required

Validations:

  • Hash

user[login]
required

Validations:

  • String

user[firstname]
optional , nil allowed

Validations:

  • String

user[lastname]
optional , nil allowed

Validations:

  • String

user[mail]
required

Validations:

  • String

user[description]
optional , nil allowed

Validations:

  • String

user[admin]
optional , nil allowed

is an admin account

Validations:

  • boolean

user[password]
required

Validations:

  • String

user[default_location_id]
optional , nil allowed

Validations:

  • Integer

user[default_organization_id]
optional , nil allowed

Validations:

  • Integer

user[auth_source_id]
required

Validations:

  • Integer

user[timezone]
optional , nil allowed

User’s timezone

Validations:

  • Must be one of: American Samoa, International Date Line West, Midway Island, Hawaii, Alaska,

    Maruku could not parse this XML/HTML: 
    <code>Pacific Time (US & Canada)</code>
    , Tijuana, Arizona, Chihuahua, Mazatlan,
    Maruku could not parse this XML/HTML: 
    <code>Mountain Time (US & Canada)</code>
    , Central America,
    Maruku could not parse this XML/HTML: 
    <code>Central Time (US & Canada)</code>
    , Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota,
    Maruku could not parse this XML/HTML: 
    <code>Eastern Time (US & Canada)</code>
    , Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, 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, 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: it, ja, gl, zh_TW, sv_SE, zh_CN, ko, en, pl, fr, ru, ca, pt_BR, en_GB, es, de.

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


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
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[admin]
optional , nil allowed

is an admin account

Validations:

  • boolean

user[password]
optional

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: American Samoa, International Date Line West, Midway Island, Hawaii, Alaska,

    Maruku could not parse this XML/HTML: 
    <code>Pacific Time (US & Canada)</code>
    , Tijuana, Arizona, Chihuahua, Mazatlan,
    Maruku could not parse this XML/HTML: 
    <code>Mountain Time (US & Canada)</code>
    , Central America,
    Maruku could not parse this XML/HTML: 
    <code>Central Time (US & Canada)</code>
    , Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota,
    Maruku could not parse this XML/HTML: 
    <code>Eastern Time (US & Canada)</code>
    , Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, 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, 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: it, ja, gl, zh_TW, sv_SE, zh_CN, ko, en, pl, fr, ru, ca, pt_BR, en_GB, es, de.

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


DELETE /api/users/:id
Delete a user

Params

Param name Description
id
required

Validations:

  • String