Users

>>>

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/auth_source_externals/:auth_source_external_id/users
List all users for external authentication source

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 d'origen d'autenticació LDAP

Validations:

  • Must be a String
usergroup_id
Optional

ID de grup d'usuaris

Validations:

  • Must be a String
role_id
Optional

ID de 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

Sort field and order, eg. ‘id DESC’

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

Search fields

Field name Tipus Possible values
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string
>>>

GET /api/users/:id
Mostra un usuari

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
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
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
user
Required

Validations:

  • Must be a Hash
user[login]
Required

Validations:

  • Must be a String
user[firstname]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[lastname]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[mail]
Required

Validations:

  • Must be a String
user[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[admin]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

é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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Integer
user[default_organization_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Integer
user[auth_source_id]
Required

Validations:

  • Must be a Integer
user[timezone]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Configuració regional preferida per l'usuari

Validations:

  • Must be one of: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, pl.
user[role_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
user[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
user[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[lastname]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[mail]
Optional

Validations:

  • Must be a String
user[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
user[admin]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

é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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Integer
user[default_organization_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Integer
user[auth_source_id]
Optional

Validations:

  • Must be a Integer
user[timezone]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Configuració regional preferida per l'usuari

Validations:

  • Must be one of: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, pl.
user[role_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
user[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
user[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
user[current_password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Required when user want to change own password

Validations:

  • Must be a String
>>>

DELETE /api/users/:id
Suprimeix un usuari

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String