GET /api/users
Llista tots els usuaris

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Llista tots els usuaris per origen d'autenticació LDAP

GET /api/usergroups/:usergroup_id/users
Llista tots els usuaris per grup dels usuaris

GET /api/roles/:role_id/users
Llista tots els usuaris per rol

GET /api/locations/:location_id/users
Llista tots els usuaris per ubicació

GET /api/organizations/:organization_id/users
Llista tots els usuaris per organització

Params

Param name Description
auth_source_ldap_id
optional

Id. de l'origen d'autenticació LDAP

Validations:

  • Must be a String

usergroup_id
optional

Id. del grup d'usuaris

Validations:

  • Must be a String

role_id
optional

Id. del rol

Validations:

  • Must be a String

location_id
optional

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Must be a Integer

search
optional

filtra els resultats

Validations:

  • Must be a String

order
optional

ordena els resultats

Validations:

  • Must be a String

page
optional

pagina els resultats

Validations:

  • Must be a String

per_page
optional

Nombre d'entrades per petició

Validations:

  • Must be a String


GET /api/users/:id
Mostra un usuari

Params

Param name Description
id
required

Validations:

  • Must be a String


POST /api/users
Crea un usuari

Adds role 'Default role' to the user by default

Params

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

és un compte d'administració

Validations:

  • Must be one of: true, false, 1, 0

user[password]
required

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

Franja horària de l'usuari

Validations:

  • Must be one of: American Samoa, International Date Line West, 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, 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

Configuració regional preferida per l'usuari

Validations:

  • Must be one of: ja, pl, zh_CN, fr, zh_TW, gl, es, de, it, en_GB, en, ru, ko, pt_BR, ca, sv_SE.

user[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els id. donats

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els id. donats.

Validations:

  • Must be an array of any type


PUT /api/users/:id
Actualitza un usuari

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:

  • 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

és un compte d'administració

Validations:

  • Must be one of: true, false, 1, 0

user[password]
optional

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

Franja horària de l'usuari

Validations:

  • Must be one of: American Samoa, International Date Line West, 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, 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

Configuració regional preferida per l'usuari

Validations:

  • Must be one of: ja, pl, zh_CN, fr, zh_TW, gl, es, de, it, en_GB, en, ru, ko, pt_BR, ca, sv_SE.

user[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els id. donats

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els id. donats.

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


DELETE /api/users/:id
Suprimeix un usuari

Params

Param name Description
id
required

Validations:

  • Must be a String