GET /api/users
Lister tous les utilisateurs

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Liste de tous les utilisateurs d'une source d'authentification LDAP

GET /api/usergroups/:usergroup_id/users
Liste de tous les utilisateurs d'un groupe

GET /api/roles/:role_id/users
Liste de tous les utilisateurs pour un rôle

GET /api/locations/:location_id/users
Liste de tous les utilisateurs d'une localisation

GET /api/organizations/:organization_id/users
Liste de tous les utilisateurs d'une organisation

Params

Param Name Description
auth_source_ldap_id
Optional

ID de la source d'authentification LDAP


Value:

Must be String

usergroup_id
Optional

ID du groupe utilisateur


Value:

Must be String

role_id
Optional

ID du rôle


Value:

Must be String

search
Optional

filtrer les résultats


Value:

Must be String

order
Optional

trier les resultats


Value:

Must be String

page
Optional

paginer les resultats


Value:

Must be String

per_page
Optional

nombre d'entier par requête


Value:

Must be String


GET /api/users/:id
Afficher un utilisateur

Params

Param Name Description
id
Required

Value:

Must be String


POST /api/users
Créer un utilisateur

Adds role 'Anonymous' to the user by default

Params

Param Name Description
user
Required

Value:

Must be a Hash

user[login]
Required

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

user[mail]
Required

Value:

Must be String

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

est un compte administrateur


Value:

Must be 'true' or 'false'

user[password]
Required

Value:

Must be String

user[auth_source_id]
Required

Value:

Must be Integer

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

Fuseau horaire de l'utilisateur


Value:

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: fr.apipie.nil_allowed">Nil Allowed</span>

Locale préférée de l'utilisateur


Value:

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


PUT /api/users/:id
Mise à jour d'un utilisateur

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

Value:

Must be String

user
Required

Value:

Must be a Hash

user[login]
Optional

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

user[mail]
Optional

Value:

Must be String

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

est un compte administrateur


Value:

Must be 'true' or 'false'

user[password]
Optional

Value:

Must be String

user[auth_source_id]
Optional

Value:

Must be Integer

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

Fuseau horaire de l'utilisateur


Value:

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: fr.apipie.nil_allowed">Nil Allowed</span>

Locale préférée de l'utilisateur


Value:

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


DELETE /api/users/:id
Supprimer un utilisateur

Params

Param Name Description
id
Required

Value:

Must be String