[comment]: # translation:outdated
[comment]: # ({2485e0f7-2485e0f7})
# user.get
[comment]: # ({/2485e0f7-2485e0f7})
[comment]: # ({36f89e39-36f89e39})
### Description
`integer/array user.get(object parameters)`
La méthode permet de récupérer les utilisateurs en fonction des paramètres donnés.
::: noteclassic
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir [Rôles Utilisateur](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations.
:::
[comment]: # ({/36f89e39-36f89e39})
[comment]: # ({c8d70767-888512e9})
### Paramètres
`(object)` Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
|Paramètre|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|mediaids|string/array|Renvoie uniquement les utilisateurs qui utilisent le média donné.|
|mediatypeids|string/array|Renvoie uniquement les utilisateurs qui utilisent les types de média donnés.|
|userids|string/array|Renvoie uniquement les utilisateurs avec les identifiants donnés.|
|usrgrpids|string/array|Renvoie uniquement les utilisateurs appartenant aux groupes d'utilisateurs donnés.|
|getAccess|flag|Ajoute des informations supplémentaires sur les autorisations des utilisateurs.
Ajoute les propriétés suivantes pour chaque utilisateur :
`gui_access` - *(integer)* méthode d'authentification frontale de l'utilisateur. Reportez-vous à la propriété `gui_access` de l'[objet groupe d'utilisateurs](/manual/api/reference/usergroup/object#user_group) pour obtenir une liste des valeurs possibles.
`debug_mode` - *(integer)* indique si le mode debug est activé pour l'utilisateur. Valeurs possibles : 0 - debug désactivé, 1 - debug activé.
`users_status` - *(integer)* indique si l'utilisateur est désactivé. Valeurs possibles : 0 - utilisateur activé, 1 - utilisateur désactivé.|
|selectMedias|query|Renvoie le média utilisé par l'utilisateur dans la propriété [medias](/manual/api/reference/user/object#media).|
|selectMediatypes|query|Renvoie les types de média utilisés par l'utilisateur dans la propriété [mediatypes](/manual/api/reference/mediatype/object).|
|selectUsrgrps|query|Renvoie les groupes d'utilisateurs auxquels l'utilisateur appartient dans la propriété [usrgrps](/manual/api/reference/usergroup/object).|
|selectRole|query|Renvoie le rôle utilisateur dans la propriété [role](/manual/api/reference/role/object#role).|
|sortfield|string/array|Trie le résultat par les propriétés données.
Les valeurs possibles sont : `userid` et `username`.|
|countOutput|boolean|Ces paramètres, communs à toutes les méthodes `get`, sont décrits dans les [commentaires de référence](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
[comment]: # ({/c8d70767-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]: # ({bf3b0e50-7b5c610b})
#### Récupération des utilisateurs
Récupérez tous les utilisateurs configurés.
Requête :
```json
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Réponse :
```json
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "en_GB",
"refresh": "0s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "3"
},
{
"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"
},
{
"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"
}
],
"id": 1
}
```
[comment]: # ({/bf3b0e50-7b5c610b})
[comment]: # ({new-746d14f7})
#### Retrieving users as *Admin*
As an *Admin* type user, retrieve detailed data about your own user and limited data for users in your user group.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}
```
Response:
```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"
}
]
},
{
"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",
"gui_access": "0",
"debug_mode": "0",
"users_status": "0",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
}
],
"medias": [
{
"mediaid": "2",
"userid": "3",
"mediatypeid": "1",
"sendto": [
"john.doe@example.com"
],
"active": "0",
"severity": "63",
"period": "1-7,00:00-24:00"
}
],
"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]: # ({/new-746d14f7})
[comment]: # ({b2b58125-d85f9654})
#### Récupération des données utilisateur
Récupérer les données d'un utilisateur avec l'ID "12".
Requête :
``` {.java}
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Réponse :
``` {.java}
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}
```
[comment]: # ({/b2b58125-d85f9654})
[comment]: # ({8d892781-8d892781})
### Voir également
- [Media](/manual/api/reference/user/object#media)
- [Type de média](/manual/api/reference/mediatype/object#media_type)
- [Groupe utilisateur](/manual/api/reference/usergroup/object#user_group)
- [Rôle](/manual/api/reference/role/object#role)
[comment]: # ({/8d892781-8d892781})
[comment]: # ({842f2a42-842f2a42})
### Source
CUser::get() dans *ui/include/classes/api/services/CUser.php*.
[comment]: # ({/842f2a42-842f2a42})