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

Paramètres

Nom du paramètre Description
auth_source_ldap_id
optionel

ID de la source d'authentification LDAP

Validations:

  • Must be a String

usergroup_id
optionel

ID du groupe utilisateur

Validations:

  • Must be a String

role_id
optionel

ID du rôle

Validations:

  • Must be a String

location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les resultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String


GET /api/users/:id
Afficher un utilisateur

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String


POST /api/users
Créer un utilisateur

Adds role 'Default role' to the user by default

Paramètres

Nom du paramètre Description
user
requis

Validations:

  • Must be a Hash

user[login]
requis

Validations:

  • Must be a String

user[firstname]
optionel , nil autorisé

Validations:

  • Must be a String

user[lastname]
optionel , nil autorisé

Validations:

  • Must be a String

user[mail]
requis

Validations:

  • Must be a String

user[description]
optionel , nil autorisé

Validations:

  • Must be a String

user[admin]
optionel , nil autorisé

est un compte administrateur

Validations:

  • Must be one of: true, false, 1, 0

user[password]
requis

Validations:

  • Must be a String

user[default_location_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[default_organization_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[auth_source_id]
requis

Validations:

  • Must be a Integer

user[timezone]
optionel , nil autorisé

Fuseau horaire de l'utilisateur

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]
optionel , nil autorisé

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

Validations:

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

user[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

user[organization_ids]
optionel , nil autorisé

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.

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String

user
requis

Validations:

  • Must be a Hash

user[login]
optionel

Validations:

  • Must be a String

user[firstname]
optionel , nil autorisé

Validations:

  • Must be a String

user[lastname]
optionel , nil autorisé

Validations:

  • Must be a String

user[mail]
optionel

Validations:

  • Must be a String

user[description]
optionel , nil autorisé

Validations:

  • Must be a String

user[admin]
optionel , nil autorisé

est un compte administrateur

Validations:

  • Must be one of: true, false, 1, 0

user[password]
optionel

Validations:

  • Must be a String

user[default_location_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[default_organization_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[auth_source_id]
optionel

Validations:

  • Must be a Integer

user[timezone]
optionel , nil autorisé

Fuseau horaire de l'utilisateur

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]
optionel , nil autorisé

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

Validations:

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

user[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

user[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type

user[current_password]
optionel , nil autorisé

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
Supprimer un utilisateur

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String