GET /api/users
Elenca tutti gli utenti

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Elenca tutti gli utenti per il sorgente di autenticazione LDAP

GET /api/usergroups/:usergroup_id/users
Elenca tutti gli utenti per gruppo

GET /api/roles/:role_id/users
Elenca tutti gli utenti per il ruolo

GET /api/locations/:location_id/users
Elenca tutti gli utenti per la posizione

GET /api/organizations/:organization_id/users
Elenca tutti gli utenti per l'organizzazione

Params

Param Name Description
auth_source_ldap_id
Optional

ID del sorgente di autenticazione LDAP

Validations:

  • Must be String

usergroup_id
Optional

ID gruppo di utenti

Validations:

  • Must be String

role_id
Optional

ID ruolo

Validations:

  • Must be String

search
Optional

filtra i risultati

Validations:

  • Must be String

order
Optional

ordina risultati

Validations:

  • Must be String

page
Optional

paginazione risultati

Validations:

  • Must be String

per_page
Optional

numero di voci per richiesta

Validations:

  • Must be String


GET /api/users/:id
Mostra un utente

Params

Param Name Description
id
Required

Validations:

  • Must be String


POST /api/users
Crea un utente

Adds role 'Anonymous' to the user by default

Params

Param Name Description
user
Required

Validations:

  • Must be a Hash

user[login]
Required

Validations:

  • Must be String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[mail]
Required

Validations:

  • Must be String

user[admin]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

è un account amministrativo

Validations:

  • Must be 'true' or 'false' or '1' or '0'

user[password]
Required

Validations:

  • Must be String

user[auth_source_id]
Required

Validations:

  • Must be Integer

user[timezone]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

User's timezone

Validations:

  • Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa.

user[locale]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

User's preferred locale

Validations:

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


PUT /api/users/:id
Aggiorna un utente

Adds role 'Anonymous' 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 String

user
Required

Validations:

  • Must be a Hash

user[login]
Optional

Validations:

  • Must be String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[mail]
Optional

Validations:

  • Must be String

user[admin]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

è un account amministrativo

Validations:

  • Must be 'true' or 'false' or '1' or '0'

user[password]
Optional

Validations:

  • Must be String

user[auth_source_id]
Optional

Validations:

  • Must be Integer

user[timezone]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

User's timezone

Validations:

  • Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa.

user[locale]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

User's preferred locale

Validations:

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


DELETE /api/users/:id
Cancella un utente

Params

Param Name Description
id
Required

Validations:

  • Must be String