[comment]: # translation:outdated
[comment]: # ({2485e0f7-2485e0f7})
# user.get
[comment]: # ({/2485e0f7-2485e0f7})
[comment]: # ({36f89e39-36f89e39})
### Descripción
`entero/matriz usuario.get(parámetros de objeto)`
El método permite recuperar usuarios según los parámetros dados.
::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos para
llamar al método se pueden revocar en la configuración de roles de usuario. Ver [Roles de usuario
](/manual/interfaz_web/secciones_frontend/administración/roles_usuario)
para más información.
:::
[comment]: # ({/36f89e39-36f89e39})
[comment]: # ({c8d70767-888512e9})
### Parámetros
`(objeto)` Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|mediaids|cadena/matriz|Devuelve solo los usuarios que usan el medio dado.|
|mediatypeids|string/array|Devuelve solo los usuarios que usan los tipos de medios dados.|
|userids|cadena/matriz|Devuelve solo usuarios con los ID proporcionados.|
|usrgrpids|string/array|Devuelve sólo los usuarios que pertenecen a los grupos de usuarios dados.|
|getAccess|flag|Agrega información adicional sobre los permisos de usuario.
Agrega las siguientes propiedades para cada usuario:
`gui_access` - *(entero)* método de autenticación de interfaz del usuario. Consulte la propiedad `gui_access` del [objeto de grupo de usuarios](/manual/api/reference/usergroup/object#user_group) para obtener una lista de valores posibles.
`debug_mode` - *(integer)* indica si se debe depurar está habilitado para el usuario. Valores posibles: 0 - depuración deshabilitada, 1 - depuración habilitada.
`users_status` - *(entero)* indica si el usuario está deshabilitado. Valores posibles: 0 - usuario habilitado, 1 - usuario deshabilitado.|
|selectMedias|query|Devuelve los medios utilizados por el usuario en la propiedad [medias](/manual/api/reference/user/object#media).|
|selectMediatypes|query|Devuelve los tipos de medios utilizados por el usuario en la propiedad [mediatypes](/manual/api/reference/mediatype/object).|
|selectUsrgrps|query|Devuelve los grupos de usuarios a los que pertenece el usuario en la propiedad [usrgrps](/manual/api/reference/usergroup/object).|
|selectRole|query|Devuelve el rol de usuario en la propiedad [role](/manual/api/reference/role/object#role).|
|sortfield|string/array|Ordena el resultado según las propiedades dadas.
Los valores posibles son: `userid` y `username`.|
|countOutput|boolean|Estos parámetros, que son comunes para todos los métodos `get`, se describen detalladamente en el [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excluirBuscar|booleano|^|
|filtro|objeto|^|
|límite|entero|^|
|salida|consulta|^|
|preservekeys|booleano|^|
|buscar|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|clasificación|cadena/matriz|^|
|iniciarBuscar|booleano|^|
[comment]: # ({/c8d70767-888512e9})
[comment]: # ({7223bab1-7223bab1})
### Valores de retorno
`(entero/matriz)` Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput`
ha sido usado.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Ejemplos
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({bf3b0e50-7b5c610b})
#### Recuperando usuarios
Recupera todos los usuarios configurados.
Pedido:
```json
{
"jsonrpc": "2.0",
"método": "usuario.get",
"parámetros": {
"salida": "extender"
},
"autenticación": "038e1d7b1735c6a5436ee9eae095879e",
"identificación": 1
}
```
Respuesta:
```json
{
"jsonrpc": "2.0",
"resultado": [
{
"ID de usuario": "1",
"nombre de usuario": "Administrador",
"nombre": "Zabbix",
"apellido": "Administrador",
"URL": "",
"autologin": "1",
"cierre de sesión automático": "0",
"lang": "en_ES",
"actualizar": "0s",
"tema": "predeterminado",
"intento_fallido": "0",
"intento_ip": "",
"intento_reloj": "0",
"rows_per_page": "50",
"zona horaria": "predeterminado",
"roleid": "3"
},
{
"ID de usuario": "2",
"nombre de usuario": "invitado",
"nombre": "",
"apellido": "",
"URL": "",
"autologin": "0",
"cierre de sesión automático": "15m",
"idioma": "predeterminado",
"actualizar": "30s",
"tema": "predeterminado",
"intento_fallido": "0",
"intento_ip": "",
"intento_reloj": "0",
"rows_per_page": "50",
"zona horaria": "predeterminado",
"roleid": "4"
},
{
"ID de usuario": "3",
"nombre de usuario": "usuario",
"nombre": "Zabbix",
"apellido": "Usuario",
"URL": "",
"autologin": "0",
"cierre de sesión automático": "0",
"lang": "ru_RU",
"actualizar": "15s",
"tema": "tema oscuro",
"intento_fallido": "0",
"intento_ip": "",
"intento_reloj": "0",
"rows_per_page": "100",
"zona horaria": "predeterminado",
"roleid": "1"
}
],
"identificación": 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})
#### Recuperando datos de usuario
Recuperar datos de un usuario con ID "12".
Pedido:
```json
{
"jsonrpc": "2.0",
"método": "usuario.get",
"parámetros": {
"salida": ["ID de usuario", "nombre de usuario"],
"selectRole": "extender",
"ID de usuario": "12"
},
"autenticación": "038e1d7b1735c6a5436ee9eae095879e",
"identificación": 1
}
```
Respuesta:
``` {.java}
{
"jsonrpc": "2.0",
"resultado": [
{
"ID de usuario": "12",
"nombre de usuario": "Juan",
"role": {
"roleid": "5",
"nombre": "Operador",
"tipo 1",
"solo lectura": "0"
}
}
],
"identificación": 1
}
```
[comment]: # ({/b2b58125-d85f9654})
[comment]: # ({8d892781-8d892781})
### Ver también
- [Medios](/manual/api/reference/user/object#media)
- [Tipo de medio](/manual/api/reference/mediatype/object#media_type)
- [Grupo de usuarios](/manual/api/reference/usergroup/object#user_group)
- [Rol](/manual/api/reference/rol/object#rol)
[comment]: # ({/8d892781-8d892781})
[comment]: # ({842f2a42-842f2a42})
### Fuente
CUser::get() en *ui/include/classes/api/services/CUser.php*.
[comment]: # ({/842f2a42-842f2a42})