GET /api/users
Afficher tous les utilisateurs

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

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

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

GET /api/locations/:location_id/users
Afficher tous les utilisateurs d'un emplacement

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

Params

Param Name Description
auth_source_ldap_id
Optional

ID de la source d'authentification LDAP

Validations:

  • Must be String

usergroup_id
Optional

ID du groupe utilisateur

Validations:

  • Must be String

role_id
Optional

ID du rôle

Validations:

  • Must be String

location_id
Optional

Tri par emplacement

Validations:

  • Must be Integer

organization_id
Optional

Tri par organisation

Validations:

  • Must be Integer

search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d'entier par requête

Validations:

  • Must be String


GET /api/users/:id
Afficher un utilisateur

Params

Param Name Description
id
Required

Validations:

  • Must be String


POST /api/users
Créer un utilisateur

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 String

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

Validations:

  • Must be String

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

est un compte administrateur

Validations:

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

user[password]
Required

Validations:

  • Must be String

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

Validations:

  • Must be Integer

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

Validations:

  • Must be Integer

user[auth_source_id]
Required

Validations:

  • 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

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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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, Srednekolymsk, 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

Validations:

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

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

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

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

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


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

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

Validations:

  • Must be String

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

est un compte administrateur

Validations:

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

user[password]
Optional

Validations:

  • Must be String

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

Validations:

  • Must be Integer

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

Validations:

  • Must be Integer

user[auth_source_id]
Optional

Validations:

  • 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

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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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, Srednekolymsk, 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

Validations:

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

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

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

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

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


DELETE /api/users/:id
Supprimer un utilisateur

Params

Param Name Description
id
Required

Validations:

  • Must be String