usergroup.get

Descrição

integer/array usergroup.get(object parameters)

O método permite recuperar grupos de usuários de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parameter Type Description
mfaids ID/array Retorna apenas grupos de usuários com os métodos MFA informados.

Comportamento do parâmetro:
- supported para usuários do tipo Super admin (desde Zabbix 7.0.9)
mfa_status integer Retorna apenas grupos de usuários com o status MFA informado.

Consulte a página do grupo de usuários para obter uma lista dos status suportados.
status integer Retorna apenas grupos de usuários com o status informado.

Consulte a página do grupo de usuários para obter uma lista dos status suportados.
userids ID/array Retorna apenas grupos de usuários que contêm os usuários informados.
usrgrpids ID/array Retorna apenas grupos de usuários com os IDs informados.
selectTagFilters query Retorna as permissões baseadas em tags do grupo de usuários na propriedade tag_filters.
selectUsers query Retorna os usuários do grupo de usuários na propriedade users.

Consulte user.get para restrições com base no tipo de usuário.
selectHostGroupRights query Retorna as permissões do grupo de usuários para grupos de host na propriedade hostgroup_rights.

Consulte a página do grupo de usuários para obter uma lista dos níveis de acesso aos grupos de host.
selectTemplateGroupRights query Retorna as permissões do grupo de usuários para grupos de template na propriedade templategroup_rights.

Consulte a página do grupo de usuários para obter uma lista dos níveis de acesso aos grupos de template.
limitSelects integer Limita o número de registros retornados pelos subselects.
output query Propriedades do objeto de grupo de usuários a serem retornadas.

Desde o Zabbix 7.0.9, usuários do tipo Admin e User podem recuperar apenas as seguintes propriedades: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Padrão: extend.
sortfield string/array Classifica o resultado pelas propriedades informadas.

Valores possíveis: usrgrpid, name.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
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; use selectHostGroupRights ou selectTemplateGroupRights em seu lugar.
Retorna os direitos do grupo de usuários na propriedade rights.
Consulte a página do grupo de usuários para obter uma lista dos níveis de acesso aos grupos de host.

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput foi utilizado.

Exemplos

Recuperando grupos de usuários habilitados

Recupere todos os grupos de usuários habilitados.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "usergroup.get",
    "params": {
        "output": "extend",
        "status": 0
    },
    "id": 1
}

Resposta:

{
    "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
}

Veja também

Fonte

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