[comment]: # translation:outdated [comment]: # ({2485e0f7-2485e0f7}) # user.get [comment]: # ({/2485e0f7-2485e0f7}) [comment]: # ({5aeb1b12-36f89e39}) ### Description `integer/array user.get(object parameters)` La méthode permet de récupérer des utilisateurs selon les paramètres fournis. ::: noteclassic Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir [User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d’informations. ::: [comment]: # ({/5aeb1b12-36f89e39}) [comment]: # ({d5bb139f-888512e9}) ### Paramètres `(object)` Paramètres définissant la sortie souhaitée. La méthode prend en charge les paramètres suivants. ::: noteclassic Lors de la demande d'informations sur les médias utilisateur, les permissions ou les rôles, les utilisateurs de type *Admin* et *User* ne peuvent récupérer des données que sur leur propre utilisateur. Pour un exemple, voir [Récupération des utilisateurs en tant qu'*Admin*](#retrieving-users-as-admin). ::: |Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |mediaids|ID/array|Ne renvoyer que les utilisateurs qui utilisent le média indiqué.| |mediatypeids|ID/array|Ne renvoyer que les utilisateurs qui utilisent les types de média indiqués.| |userids|ID/array|Ne renvoyer que les utilisateurs ayant les ID indiqués.| |usrgrpids|ID/array|Ne renvoyer que les utilisateurs qui appartiennent aux groupes d'utilisateurs indiqués.| |getAccess|flag|Ajoute des informations supplémentaires sur les permissions de l'utilisateur.

Ajoute les propriétés suivantes pour chaque utilisateur :
`gui_access` - `(integer)` méthode d'authentification de l'utilisateur dans l'interface. Reportez-vous à la propriété `gui_access` de l'[objet groupe d'utilisateurs](/manual/api/reference/usergroup/object#user-group) pour obtenir la liste des valeurs possibles.
`debug_mode` - `(integer)` indique si le débogage est activé pour l'utilisateur. Valeurs possibles : 0 - débogage désactivé, 1 - débogage activé.
`users_status` - `(integer)` indique si l'utilisateur est désactivé. Valeurs possibles : 0 - utilisateur activé, 1 - utilisateur désactivé.| |selectMedias|query|Renvoyer les médias utilisés par l'utilisateur dans la propriété [`medias`](/manual/api/reference/user/object#media).| |selectMediatypes|query|Renvoyer les types de média utilisés par l'utilisateur dans la propriété [`mediatypes`](/manual/api/reference/mediatype/object).

Voir [`mediatype.get`](/manual/api/reference/mediatype/get) pour les restrictions selon le type d'utilisateur.| |selectUsrgrps|query|Renvoyer les groupes d'utilisateurs auxquels l'utilisateur appartient dans la propriété [`usrgrps`](/manual/api/reference/usergroup/object).

Voir [`usergroup.get`](/manual/api/reference/usergroup/get) pour les restrictions selon le type d'utilisateur.| |selectRole|query|Renvoyer le rôle de l'utilisateur dans la propriété [`role`](/manual/api/reference/role/object#role).| |filter|object|Ne renvoyer que les résultats qui correspondent exactement au filtre indiqué.

Accepte un objet où les clés sont des noms de propriété et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.

Ne prend pas en charge les propriétés de type de données `text` [type de données](/manual/api/reference_commentary#data-types).

Propriétés possibles de l'[objet utilisateur](/manual/api/reference/user/object) pour les utilisateurs de type *Admin* et *User* lors de la demande de données sur des utilisateurs de leur groupe d'utilisateurs : `userid`, `name`, `surname`, `username`.| |output|query|Propriétés de l'[objet utilisateur](/manual/api/reference/user/object) à renvoyer.

Les utilisateurs de type *Admin* et *User* ne peuvent récupérer que les propriétés suivantes :
- Pour leur propre utilisateur : `userid`, `attempt_clock`, `attempt_failed`, `attempt_ip`, `autologin`, `autologout`, `lang`, `name`, `provisioned`, `refresh`, `roleid`, `rows_per_page`, `surname`, `theme`, `timezone`, `url`, `username`.
- Pour les utilisateurs de leur groupe d'utilisateurs : `userid`, `name`, `surname`, `username`.

Par défaut : `extend`.| |search|object|Renvoyer les résultats qui correspondent au motif indiqué (insensible à la casse).

Accepte un objet où les clés sont des noms de propriété et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est fournie, cela effectuera une recherche `LIKE "%…%"`.

Prend en charge uniquement les propriétés de type de données `string` et `text` [type de données](/manual/api/reference_commentary#data-types).

Propriétés possibles de l'[objet utilisateur](/manual/api/reference/user/object) pour les utilisateurs de type *Admin* et *User* lors de la demande de données sur des utilisateurs de leur groupe d'utilisateurs : `name`, `surname`, `username`.| |sortfield|string/array|Trier le résultat selon les propriétés indiquées.

Valeurs possibles : `userid`, `username`.| |countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |preservekeys|boolean|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/d5bb139f-888512e9}) [comment]: # ({7223bab1-7223bab1}) ### Valeurs retournées `(integer/array)` Renvoie soit : - un tableau d'objets ; - le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemples [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6a55e19e-7b5c610b}) #### Récupération des utilisateurs Récupérez tous les utilisateurs configurés. [Requête](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend" }, "id": 1 } ``` Réponse : ```json { "jsonrpc": "2.0", "result": [ { "userid": "1", "username": "Admin", "name": "Zabbix", "surname": "Administrator", "url": "", "autologin": "1", "autologout": "0", "lang": "en_US", "refresh": "0s", "theme": "default", "attempt_failed": "0", "attempt_ip": "", "attempt_clock": "0", "rows_per_page": "50", "timezone": "default", "roleid": "3", "userdirectoryid": "0", "ts_provisioned": "0" }, { "userid": "2", "username": "guest", "name": "", "surname": "", "url": "", "autologin": "0", "autologout": "15m", "lang": "default", "refresh": "30s", "theme": "default", "attempt_failed": "0", "attempt_ip": "", "attempt_clock": "0", "rows_per_page": "50", "timezone": "default", "roleid": "4", "userdirectoryid": "0", "ts_provisioned": "0" }, { "userid": "3", "username": "user", "name": "Zabbix", "surname": "User", "url": "", "autologin": "0", "autologout": "0", "lang": "ru_RU", "refresh": "15s", "theme": "dark-theme", "attempt_failed": "0", "attempt_ip": "", "attempt_clock": "0", "rows_per_page": "100", "timezone": "default", "roleid": "1", "userdirectoryid": "0", "ts_provisioned": "0" } ], "id": 1 } ``` [comment]: # ({/6a55e19e-7b5c610b}) [comment]: # ({93e2b113-18cd65ae}) #### Récupération des utilisateurs en tant qu’*Admin* En tant qu’utilisateur de type *Admin*, récupérez des données détaillées sur votre propre utilisateur ainsi que des données limitées pour les utilisateurs de votre groupe d’utilisateurs. [Requête](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend", "getAccess": true, "selectMedias": "extend", "selectMediatypes": "extend", "selectUsrgrps": "extend", "selectRole": "extend" }, "id": 1 } ``` Réponse : ```json { "jsonrpc": "2.0", "result": [ { "userid": "1", "username": "Admin", "name": "Zabbix", "surname": "Administrator", "usrgrps": [ { "usrgrpid": "7", "name": "Zabbix administrators", "gui_access": "0", "users_status": "0", "debug_mode": "0", "mfa_status": "0" } ] }, { "userid": "3", "username": "database-admin", "name": "John", "surname": "Doe", "url": "", "autologin": "0", "autologout": "0", "lang": "default", "refresh": "30s", "theme": "default", "attempt_failed": "0", "attempt_ip": "", "attempt_clock": "0", "rows_per_page": "50", "timezone": "default", "roleid": "2", "provisioned": "0", "gui_access": "0", "debug_mode": "0", "users_status": "0", "usrgrps": [ { "usrgrpid": "7", "name": "Zabbix administrators", "gui_access": "0", "users_status": "0", "debug_mode": "0", "mfa_status": "0" } ], "medias": [ { "mediaid": "2", "mediatypeid": "1", "sendto": [ "john.doe@example.com" ], "active": "0", "severity": "63", "period": "1-7,00:00-24:00", "provisioned": 0 } ], "mediatypes": [ { "mediatypeid": "1", "type": "0", "name": "Email", "status": "0", "description": "", "maxattempts": "3" } ], "role": { "roleid": "2", "name": "Admin role", "type": "2", "readonly": "0" } } ], "id": 1 } ``` [comment]: # ({/93e2b113-18cd65ae}) [comment]: # ({2c8d809a-d85f9654}) #### Récupération des données utilisateur Récupérez les données d'un utilisateur avec l'ID « 12 ». [Requête](/manual/api#performing-requests) : ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": ["userid", "username"], "selectRole": "extend", "userids": "12" }, "id": 1 } ``` Réponse : ```json { "jsonrpc": "2.0", "result": [ { "userid": "12", "username": "John", "role": { "roleid": "5", "name": "Operator", "type": "1", "readonly": "0" } } ], "id": 1 } ``` [comment]: # ({/2c8d809a-d85f9654}) [comment]: # ({f7109d71-8d892781}) ### Voir aussi - [Média](/manual/api/reference/user/object#media) - [Type de média](/manual/api/reference/mediatype/object#media-type) - [Groupe d'utilisateurs](/manual/api/reference/usergroup/object#user-group) - [Rôle](/manual/api/reference/role/object#role) [comment]: # ({/f7109d71-8d892781}) [comment]: # ({842f2a42-842f2a42}) ### Source CUser::get() dans *ui/include/classes/api/services/CUser.php*. [comment]: # ({/842f2a42-842f2a42})