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 se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
mediaids ID/matriz Devuelve sólo los usuarios que utilizan los medios dados.
mediatypeids ID/matriz Devuelve solo los usuarios que usan los tipos de medios dados.
userids ID/matriz Devuelve solo usuarios con los ID proporcionados.
usrgrpids ID/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 - método de autenticación de frontend del usuario (entero). Consulte la propiedad gui_access del objeto de grupo de usuarios 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.
selectMediatypes query Devuelve los tipos de medios utilizados por el usuario en la propiedad mediatypes.
selectUsrgrps query Devuelve los grupos de usuarios a los que pertenece el usuario en la propiedad usrgrps.
selectRole query Devuelve el rol de usuario en la propiedad role.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: userid, username.
countOutput boolean Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
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

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando 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_GB",
                   "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
       }

Recuperando datos de usuario

Recuperar 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.