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

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

El método admite los siguientes parámetros.

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

Comportamiento del parámetro:
- admitido para usuarios de tipo Super admin
mfa_status integer Devolver solo los grupos de usuarios con el estado MFA indicado.

Consulte la página de grupo de usuarios para ver la lista de estados admitidos.
status integer Devolver solo los grupos de usuarios con el estado indicado.

Consulte la página de grupo de usuarios para ver la lista de estados admitidos.
userids ID/array Devolver solo los grupos de usuarios que contienen los usuarios indicados.
usrgrpids ID/array Devolver solo los grupos de usuarios con los IDs indicados.
selectTagFilters query Devolver los permisos basados en etiquetas del grupo de usuarios en la propiedad tag_filters.
selectUsers query Devolver 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 Devolver los permisos del grupo de usuarios sobre los grupos de hosts en la propiedad hostgroup_rights.

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

Consulte la página de grupo 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 subconsultas.
output query Propiedades del objeto 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.

Por defecto: extend.
sortfield string/array Ordenar 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

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
}

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
}

Ver también

Fuente

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