[comment]: # translation:outdated

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

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

[comment]: # ({ef79b8a9-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 do usuário. Consulte [Funções do usuário](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.
:::

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

[comment]: # ({ec24a83b-4be9c06e})
### Parâmetros
  
`(object)` Parâmetros que definem a saída desejada.
  
O método oferece suporte aos parâmetros a seguir.
  
|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|status|integer|Retorne 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|string/array|Retorna apenas grupos de usuários que contêm os usuários fornecidos.|  
|usrgrpids|string/array|Retorna apenas grupos de usuários com os IDs fornecidos.|
|selectTagFilters|query|Retorna permissões baseadas em etiquetas de grupo de usuários na propriedade [tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission).<br><br>Tem as seguintes propriedades:<br>`groupid` - (string ) ID do grupo de hosts;<br>`tag` - (string) nome da etiqueta;<br>`value` - (string) valor da etiqueta.|
|selectUsers|query|Retorne os usuários do grupo de usuários na propriedade [users](/manual/api/reference/user/object#user).|  
|selectRights|query|Retorne direitos de grupo de usuários em propriedade [rights](/manual/api/reference/usergroup/object#permission).<br><br>Possui as seguintes propriedades:<br>`permission` - nível de acesso (inteiro) ao grupo de hosts;<br>`id` - (string) ID do grupo de hosts.<br><br>Consulte a [página do grupo de usuários](objeto#permissão) para obter uma lista de níveis de acesso aos grupos de hosts.|  
|limitSelects|integer|Limite o número de registros retornados por subseleções.|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `usrgrpid`, `name`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes no [comentário de referência](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/ec24a83b-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]: # ({a3c99a8f-62cd5d8e})
#### Recuperando grupos de usuários habilitados
  
Recuperar todos os grupos de usuários habilitados.

Request:

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

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix administrators",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "8",
            "name": "Guests",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Enabled debug mode",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "12",
            "name": "No access to the frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Read only",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Deny",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/a3c99a8f-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})