Users

>>>

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

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

Parametri

Nome parametro Descrizione
auth_source_ldap_id
opzionale

ID del sorgente di autenticazione LDAP

Validations:

  • Must be a String
usergroup_id
opzionale

ID gruppo di utenti

Validations:

  • Must be a String
role_id
opzionale

ID ruolo

Validations:

  • Must be a String
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer
organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer
search
opzionale

filtra i risultati

Validations:

  • Must be a String
order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.
per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
admin true, false
auth_source
auth_source_type
description
firstname
last_login_on
lastname
location
location_id
login
mail
organization
organization_id
role
role_id
usergroup
>>>

GET /api/users/:id
Mostra un utente

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be a String
>>>

GET /api/current_user
Show the currently logged-in user

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
>>>

POST /api/users
Crea un utente

Adds role 'Default role' to the user by default

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
user
richiesto

Validations:

  • Must be a Hash
user[login]
richiesto

Validations:

  • Must be a String
user[firstname]
opzionale , consentito nil

Validations:

  • Must be a String
user[lastname]
opzionale , consentito nil

Validations:

  • Must be a String
user[mail]
richiesto

Validations:

  • Must be a String
user[description]
opzionale , consentito nil

Validations:

  • Must be a String
user[admin]
opzionale , consentito nil

è un account amministrativo

Validations:

  • Must be one of: true, false, 1, 0.
user[password]
opzionale , consentito nil

Required unless user is in an external authentication source

Validations:

  • Must be a String
user[default_location_id]
opzionale , consentito nil

Validations:

  • Must be a Integer
user[default_organization_id]
opzionale , consentito nil

Validations:

  • Must be a Integer
user[auth_source_id]
richiesto

Validations:

  • Must be a Integer
user[timezone]
opzionale , consentito nil

User's timezone

Validations:

  • Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Chihuahua, 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, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Casablanca, Copenhagen, Dublin, 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, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, 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]
opzionale , consentito nil

User's preferred locale

Validations:

  • Must be one of: zh_CN, ko, en, en_GB, fr, zh_TW, pl, ja, ca, es, cs_CZ, gl, sv_SE, ru, nl_NL, de, it, pt_BR.
user[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type
user[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type
user[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type
>>>

PUT /api/users/:id
Aggiorna un utente

Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be a String
user
richiesto

Validations:

  • Must be a Hash
user[login]
opzionale

Validations:

  • Must be a String
user[firstname]
opzionale , consentito nil

Validations:

  • Must be a String
user[lastname]
opzionale , consentito nil

Validations:

  • Must be a String
user[mail]
opzionale

Validations:

  • Must be a String
user[description]
opzionale , consentito nil

Validations:

  • Must be a String
user[admin]
opzionale , consentito nil

è un account amministrativo

Validations:

  • Must be one of: true, false, 1, 0.
user[password]
opzionale , consentito nil

Required unless user is in an external authentication source

Validations:

  • Must be a String
user[default_location_id]
opzionale , consentito nil

Validations:

  • Must be a Integer
user[default_organization_id]
opzionale , consentito nil

Validations:

  • Must be a Integer
user[auth_source_id]
opzionale

Validations:

  • Must be a Integer
user[timezone]
opzionale , consentito nil

User's timezone

Validations:

  • Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Chihuahua, 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, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Casablanca, Copenhagen, Dublin, 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, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, 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]
opzionale , consentito nil

User's preferred locale

Validations:

  • Must be one of: zh_CN, ko, en, en_GB, fr, zh_TW, pl, ja, ca, es, cs_CZ, gl, sv_SE, ru, nl_NL, de, it, pt_BR.
user[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type
user[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type
user[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type
user[current_password]
opzionale , consentito nil

Required when user want to change own password

Validations:

  • Must be a String
>>>

DELETE /api/users/:id
Cancella un utente

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be a String