Users

>>>

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/auth_source_externals/:auth_source_external_id/users
Afficher tous les utilisateurs d'une source d'authentification externe

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 d'utilisateurs

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

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
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
Afficher un utilisateur

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

Validations:

  • Must be a String
>>>

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
>>>

POST /api/users
Créer un utilisateur

Adds role 'Default role' to the user by default

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
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]
optionel , nil autorisé

Obligatoire sauf si l'utilisateur se trouve dans une source d'authentification externe

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

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

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

Validations:

  • Must be an array of any type
user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
user[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

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
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
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 , nil autorisé

Obligatoire sauf si l'utilisateur se trouve dans une source d'authentification externe

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

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

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

Validations:

  • Must be an array of any type
user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
user[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
user[current_password]
optionel , nil autorisé

Nécessaire lorsque l'utilisateur souhaite modifier son propre mot de passe

Validations:

  • Must be a String
>>>

DELETE /api/users/:id
Supprimer un utilisateur

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

Validations:

  • Must be a String