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.

Desde Zabbix 7.0.9, al solicitar información de medios de usuario, permisos o roles, los usuarios de tipo Admin y User solo pueden recuperar datos sobre su propio usuario. Para ver un ejemplo, consulte Recuperar usuarios como Admin.

Parameter Type Description
mediaids ID/array Devuelve solo los usuarios que usan el medio indicado.
mediatypeids ID/array Devuelve solo los usuarios que usan los tipos de medio indicados.
userids ID/array Devuelve solo los usuarios con los IDs indicados.
usrgrpids ID/array Devuelve solo los usuarios que pertenecen a los grupos de usuarios indicados.
getAccess flag Añade información adicional sobre los permisos del usuario.

Añade las siguientes propiedades para cada usuario:
gui_access - (integer) método de autenticación del frontend del usuario. Consulte la propiedad gui_access del objeto de grupo de usuarios para ver una lista de los 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 Devuelve los medios usados por el usuario en la propiedad medias.
selectMediatypes query Devuelve los tipos de medio usados por el usuario en la propiedad mediatypes.

Consulte mediatype.get para conocer las restricciones según el tipo de usuario.
selectUsrgrps query Devuelve los grupos de usuarios a los que pertenece el usuario en la propiedad usrgrps.

Consulte usergroup.get para conocer las restricciones según el tipo de usuario.
selectRole query Devuelve el rol del usuario en la propiedad role.
filter object Devuelve solo los resultados que coinciden exactamente con el filtro indicado.

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 datos text data type.

Posibles propiedades del objeto de usuario para usuarios de tipo Admin y User al solicitar datos sobre usuarios de su grupo de usuarios (desde Zabbix 7.0.9): userid, name, surname, username.
output query Propiedades del objeto de usuario que se devolverán.

Desde Zabbix 7.0.9, 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 de su grupo de usuarios: userid, name, surname, username.

Predeterminado: extend.
search object Devuelve resultados que coinciden con el patrón indicado (sin distinción entre mayúsculas y minúsculas).

Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas en las que buscar. Si no se proporcionan opciones adicionales, esto realizará una búsqueda LIKE "%…%".

Solo admite propiedades de tipo de datos string y text data type.

Posibles propiedades del objeto de usuario para usuarios de tipo Admin y User al solicitar datos sobre usuarios de su grupo de usuarios (desde Zabbix 7.0.9): name, surname, username.
sortfield string/array Ordena 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.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}

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.

Solicitud:

{
    "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".

Solicitud:

{
    "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
}

Ver también

Fuente

CUser::get() en ui/include/classes/api/services/CUser.php.