usergroup.get

Descripción

integer/array usergroup.get(object parameters)

El método permite recuperar grupos de usuarios según los parámetros proporcionados.

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 obtener más información.

Parámetros

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

El método admite los siguientes parámetros.

Parameter Type Description
mfaids ID/array Devuelve solo grupos de usuarios con los métodos MFA indicados.

Comportamiento del parámetro:
- supported para usuarios de tipo Super admin (desde Zabbix 7.0.9)
mfa_status integer Devuelve solo grupos de usuarios con el estado MFA indicado.

Consulta 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 indicado.

Consulta la página del grupo de usuarios para obtener una lista de los estados admitidos.
userids ID/array Devuelve solo grupos de usuarios que contienen los usuarios indicados.
usrgrpids ID/array Devuelve solo grupos de usuarios con los IDs indicados.
selectTagFilters query Devuelve los permisos de grupos de usuarios basados en etiquetas en la propiedad tag_filters.
selectUsers query Devuelve los usuarios del grupo de usuarios en la propiedad users.

Consulta user.get para conocer las restricciones basadas en el tipo de usuario.
selectHostGroupRights query Devuelve los permisos del grupo de usuarios sobre grupos de host en la propiedad hostgroup_rights.

Consulta la página del grupo de usuarios para obtener una lista de los niveles de acceso a grupos de host.
selectTemplateGroupRights query Devuelve los permisos del grupo de usuarios sobre grupos de template en la propiedad templategroup_rights.

Consulta la página del grupo de usuarios para obtener una lista de los niveles de acceso a grupos de template.
limitSelects integer Limita el número de registros devueltos por las subconsultas.
output query Propiedades del objeto de grupo de usuarios que se devolverán.

Desde Zabbix 7.0.9, los usuarios de tipo Admin y User solo pueden recuperar las siguientes propiedades: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Predeterminado: extend.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: usrgrpid, name.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Este parámetro está obsoleto; utiliza selectHostGroupRights o selectTemplateGroupRights en su lugar.
Devuelve los permisos del grupo de usuarios en la propiedad rights.
Consulta la página del grupo de usuarios para obtener una lista de los niveles de acceso a grupos de host.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar grupos de usuarios habilitados

Recuperar 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",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "8",
            "name": "Guests",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Enabled debug mode",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "12",
            "name": "No access to the frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Read only",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Deny",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        }
    ],
    "id": 1
}

Véase también

Fuente

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