Esta es una traducción de la página de documentación original en español. Ayúdanos a mejorarla.

usergroup.get

Descripción

integer/array usergroup.get(object parameters)

El método permite recuperar grupos de 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
mfaids ID/array Devuelve sólo grupos de usuarios con los métodos MFA proporcionados.
mfa_status integer Devuelve solo grupos de usuarios con el estado MFA dado.

Consulte la página del grupo de usuarios para obtener una lista de los estados admitidos.
status integer Devuelve solo grupos de usuarios con el estado dado.

Consulte la página del grupo de usuarios para obtener una lista de los estados admitidos.
userids ID/matriz Devuelve sólo los grupos de usuarios que contienen los usuarios dados.
usrgrpids ID/array Devuelve sólo grupos de usuarios con los ID proporcionados.
selectTagFilters query Devuelve permisos basados en etiquetas de grupo de usuarios en la propiedad tag_filters.
selectUsers query Devuelve los usuarios del grupo de usuarios en la propiedad users.
selectHostGroupRights query Devuelve el grupo de hosts del grupo de usuarios permisos en la propiedad hostgroup_rights.

Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso a grupos anfitriones.
selectTemplateGroupRights query Devuelve el grupo de plantilla de grupo de usuarios permisos en la propiedad templategroup_rights.

Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso a grupos de plantillas.
limitSelects integer Limita el número de registros devueltos por subselecciones.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: usrgrpid, name.
countOutput boolean Estos parámetros, que son comunes para todos los métodos get, se describen detalladamente 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
selectRights
(deprecated)
query Este parámetro está en desuso, utilice selectHostGroupRights o selectTemplateGroupRights en su lugar.
Devuelva los derechos del grupo de usuarios en rights.
Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso a los grupos de hosts.

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 grupos de usuarios habilitados

Recupera todos los grupos de usuarios habilitados.

Solicitud:

{
           "jsonrpc": "2.0",
           "método": "usergroup.get",
           "parámetros": {
               "salida": "extender",
               "estado": 0
           },
           "identificación": 1
       }
Copy
✔ Copied

Respuesta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "usrgrpid": "7",
                   "name": "Administradores de Zabbix",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "8",
                   "nombre": "Invitados",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Modo de depuración habilitado",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "12",
                   "name": "No hay acceso al frontend",
                   "gui_access": "2",
                   "usuarios_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "14",
                   "nombre": "Solo lectura",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "18",
                   "nombre": "Denegar",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               }
           ],
           "identificación": 1
       }
Copy
✔ Copied

Ver también

Fuente

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.