Table of Contents
user.get
Descripción
integer/array user.get(object parameters)
El método permite recuperar usuarios según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para más información.
Parámetros
(object) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
Al solicitar información sobre medios de usuario, permisos o roles, los usuarios de tipo Admin y User solo pueden recuperar datos sobre su propio usuario. Para un ejemplo, consulte Recuperar usuarios como Admin.
| Parámetro | Tipo | Descripción |
|---|---|---|
| mediaids | ID/array | Devolver solo los usuarios que utilizan los medios indicados. |
| mediatypeids | ID/array | Devolver solo los usuarios que utilizan los tipos de medios indicados. |
| userids | ID/array | Devolver solo los usuarios con los IDs indicados. |
| usrgrpids | ID/array | Devolver solo los usuarios que pertenecen a los grupos de usuarios indicados. |
| getAccess | flag | Agrega información adicional sobre los permisos del usuario. Agrega las siguientes propiedades para cada usuario: gui_access - (integer) método de autenticación en la interfaz del usuario. Consulte la propiedad gui_access del objeto grupo de usuarios para ver una lista de valores posibles.debug_mode - (integer) indica si la depuración está habilitada para el usuario. Valores posibles: 0 - depuración deshabilitada, 1 - depuración habilitada.users_status - (integer) indica si el usuario está deshabilitado. Valores posibles: 0 - usuario habilitado, 1 - usuario deshabilitado. |
| selectMedias | query | Devolver los medios utilizados por el usuario en la propiedad medias. |
| selectMediatypes | query | Devolver los tipos de medios utilizados por el usuario en la propiedad mediatypes.Consulte mediatype.get para restricciones basadas en el tipo de usuario. |
| selectUsrgrps | query | Devolver los grupos de usuarios a los que pertenece el usuario en la propiedad usrgrps.Consulte usergroup.get para restricciones basadas en el tipo de usuario. |
| selectRole | query | Devolver el rol del usuario en la propiedad role. |
| filter | object | Devolver solo aquellos resultados que coincidan exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar. No admite propiedades de tipo de dato text data type.Posibles propiedades del objeto Usuario para usuarios de tipo Admin y User al solicitar datos de usuarios en su grupo de usuarios: userid, name, surname, username. |
| output | query | Propiedades del objeto Usuario que se devolverán. Los usuarios de tipo Admin y User solo pueden recuperar las siguientes propiedades: - Para su propio usuario: userid, attempt_clock, attempt_failed, attempt_ip, autologin, autologout, lang, name, provisioned, refresh, roleid, rows_per_page, surname, theme, timezone, url, username.- Para usuarios en su grupo de usuarios: userid, name, surname, username.Por defecto: extend. |
| search | object | Devolver resultados que coincidan con el patrón dado (no distingue mayúsculas/minúsculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas a buscar. Si no se proporcionan opciones adicionales, esto realizará una búsqueda LIKE "%…%".Solo admite propiedades de tipo de dato string y text data type.Posibles propiedades del objeto Usuario para usuarios de tipo Admin y User al solicitar datos de usuarios en su grupo de usuarios: name, surname, username. |
| sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: userid, username. |
| countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(entero/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar usuarios
Recupera todos los usuarios configurados.
Respuesta:
{
"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
}Recuperar usuarios como Admin
Como usuario de tipo Admin, recupere datos detallados sobre su propio usuario y datos limitados para los usuarios de su grupo de usuarios.
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}Respuesta:
{
"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": [
"[email protected]"
],
"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
}Recuperar datos de usuario
Recuperar los datos de un usuario con ID "12".
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Véase también
Fuente
CUser::get() en ui/include/classes/api/services/CUser.php.