Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Únase a nuestro proyecto de traducción y ayude a traducir la documentación de Zabbix a su lengua materna.

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
status entero 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 cadena/matriz Devuelve solo grupos de usuarios que contengan los usuarios dados.
usrgrpids cadena/matriz Devuelve sólo grupos de usuarios con los ID proporcionados.
selectTagFilters consulta Devuelve permisos basados en etiquetas de grupo de usuarios en la propiedad tag_filters.

Tiene las siguientes propiedades:
groupid - (string) ID del grupo de equipos;
tag - (string) nombre de etiqueta;
value - (string) valor de etiqueta.
selectUsers query Devuelve los usuarios del grupo de usuarios en la propiedad users.
selectHostGroupRights consulta Devuelve los derechos del grupo de equipos del grupo de usuarios en la propiedad hostgroup_rights.

Tiene las siguientes propiedades:
permiso - nivel de acceso (entero) al grupo de equipos;
id - (cadena) ID del grupo de equipos.

Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso a grupos de equipos.
selectTemplateGroupRights consulta Devuelve los derechos de grupo de plantilla de grupo de usuarios en la propiedad templategroup_rights.

Tiene las siguientes propiedades:
permiso - nivel de acceso (entero) al grupo de plantillas;
id - (cadena) ID del grupo de plantillas.

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

Valores posibles: usrgrpid, name.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano
selectRights
(deprecated)
consulta Este parámetro está en desuso, utilice selectHostGroupRights o selectTemplateGroupRights en su lugar.
Devuelva los derechos del grupo de usuarios en rights.

Tiene las siguientes propiedades:
permission - nivel de acceso (integer) al grupo de equipos;
id - (string) ID de el grupo de equipos.

Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso a los grupos de equipos.

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",
           "method": "usergroup.get",
           "params": {
               "output": "extend",
               "status": 0
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "usrgrpid": "7",
                   "name": "Zabbix administrators",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "8",
                   "name": "Guests",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Enabled debug mode",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "12",
                   "name": "No access to the frontend",
                   "gui_access": "2",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "14",
                   "name": "Read only",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "18",
                   "name": "Deny",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               }
           ],
           "id": 1
       }

Ver también

Fuente

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