[comment]: # ({ce8d2bd2-ce8d2bd2})
# usergroup.get

[comment]: # ({/ce8d2bd2-ce8d2bd2})

[comment]: # ({31fb9be6-ef79b8a9})
### Descrição

`integer/array usergroup.get(object parameters)`

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

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/31fb9be6-ef79b8a9})

[comment]: # ({5591bd09-4be9c06e})
### Parâmetros

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

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|mfaids|ID/array|Retorna apenas grupos de usuários com os métodos MFA fornecidos.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *suportado* para usuários do tipo *Super admin*|
|mfa_status|integer|Retorna apenas grupos de usuários com o status MFA fornecido.<br><br>Consulte a [página do grupo de usuários](object#user-group) para obter uma lista de status suportados.|
|status|integer|Retorna apenas grupos de usuários com o status fornecido.<br><br>Consulte a [página do grupo de usuários](object#user-group) para obter uma lista de status suportados.|
|userids|ID/array|Retorna apenas grupos de usuários que contenham os usuários fornecidos.|
|usrgrpids|ID/array|Retorna apenas grupos de usuários com os IDs fornecidos.|
|selectTagFilters|query|Retorna permissões baseadas em tags do grupo de usuários na propriedade [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Retorna os usuários do grupo de usuários na propriedade [`users`](/manual/api/reference/user/object#user).<br><br>Veja [`user.get`](/manual/api/reference/user/get) para restrições baseadas no tipo de usuário.|
|selectHostGroupRights|query|Retorna as [permissões](/manual/api/reference/usergroup/object#permission) do grupo de usuários para grupos de hosts na propriedade `hostgroup_rights`.<br><br>Consulte a [página do grupo de usuários](object#permission) para obter uma lista de níveis de acesso aos grupos de hosts.|
|selectTemplateGroupRights|query|Retorna as [permissões](/manual/api/reference/usergroup/object#permission) do grupo de usuários para grupos de templates na propriedade `templategroup_rights`.<br><br>Consulte a [página do grupo de usuários](object#permission) para obter uma lista de níveis de acesso aos grupos de templates.|
|limitSelects|integer|Limita o número de registros retornados por subconsultas.|
|output|query|Propriedades do [objeto de grupo de usuários](/manual/api/reference/usergroup/object) a serem retornadas.<br><br>Usuários dos tipos *Admin* e *User* podem recuperar apenas as seguintes propriedades: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Padrão: `extend`.|
|sortfield|string/array|Ordena o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `usrgrpid`, `name`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5591bd09-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno
  
`(integer/array)` Retorna:
  
- uma array de objetos;  
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({e685bea9-62cd5d8e})
#### Recuperando grupos de usuários habilitados

Recupere todos os grupos de usuários habilitados.

[Requisição](/manual/api#performing-requests):

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

Resposta:

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

[comment]: # ({/e685bea9-62cd5d8e})

[comment]: # ({039ccba1-039ccba1})
### Veja também

-   [Usuário](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

[comment]: # ({e72b2ac9-e72b2ac9})
### Fonte

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

[comment]: # ({/e72b2ac9-e72b2ac9})