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 revocarse 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 el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
mfaids ID/array Devuelve únicamente los grupos de usuarios con los métodos MFA indicados.

Comportamiento del parámetro:
- compatible con usuarios de tipo Super admin
mfa_status integer Devuelve únicamente los grupos de usuarios con el estado MFA indicado.

Consulte la página de grupos de usuarios para ver la lista de estados compatibles.
proxyids ID/array Devuelve únicamente los grupos de usuarios que contienen los proxies indicados.

Comportamiento del parámetro:
- compatible con usuarios de tipo Super admin.
proxy_groupids ID/array Devuelve únicamente los grupos de usuarios que contienen los grupos de proxies indicados.

Comportamiento del parámetro:
- compatible con usuarios de tipo Super admin.
selectProxies ID/array Devuelve una propiedad proxies con los proxies del grupo de usuarios.

Comportamiento del parámetro:
- compatible con usuarios de tipo Super admin.
selectProxyGroups ID/array Devuelve una propiedad proxy_groups con los grupos de proxies del grupo de usuarios.

Comportamiento del parámetro:
- compatible con usuarios de tipo Super admin.
status integer Devuelve únicamente los grupos de usuarios con el estado indicado.

Consulte la página de grupos de usuarios para ver la lista de estados compatibles.
userids ID/array Devuelve únicamente los grupos de usuarios que contienen a los usuarios indicados.
usrgrpids ID/array Devuelve únicamente los grupos de usuarios con los ID indicados.
selectTagFilters query Devuelve los permisos basados en etiquetas del grupo de usuarios en la propiedad tag_filters.
selectUsers query Devuelve los usuarios del grupo de usuarios en la propiedad users.

Consulte user.get para conocer las restricciones según el tipo de usuario.
selectHostGroupRights query Devuelve los permisos del grupo de usuarios sobre los grupos de hosts en la propiedad hostgroup_rights.

Consulte la página de grupos de usuarios para ver la lista de niveles de acceso a los grupos de hosts.
selectTemplateGroupRights query Devuelve los permisos del grupo de usuarios sobre los grupos de templates en la propiedad templategroup_rights.

Consulte la página de grupos de usuarios para ver la lista de niveles de acceso a los grupos de templates.
limitSelects integer Limita el número de registros devueltos por las subselecciones.
output query Propiedades del objeto de grupo de usuarios que se devolverán.

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 los comentarios de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.