Table of Contents
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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| mfaids | ID/array | Retorna apenas grupos de usuários com os métodos MFA fornecidos. Comportamento do parâmetro: - suportado para usuários do tipo Super admin |
| mfa_status | integer | Retorna apenas grupos de usuários com o status MFA fornecido. Consulte a página do grupo de usuários para uma lista de status suportados. |
| status | integer | Retorna apenas grupos de usuários com o status fornecido. Consulte a página do grupo de usuários para 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. |
| selectUsers | query | Retorna os usuários do grupo de usuários na propriedade users.Veja user.get para restrições baseadas no tipo de usuário. |
| selectHostGroupRights | query | Retorna permissões do grupo de usuários para grupos de hosts na propriedade permissões em hostgroup_rights.Consulte a página do grupo de usuários para uma lista de níveis de acesso aos grupos de hosts. |
| selectTemplateGroupRights | query | Retorna permissões do grupo de usuários para grupos de templates na propriedade permissões em templategroup_rights.Consulte a página do grupo de usuários para 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 grupo de usuários a serem retornadas. Usuários dos tipos 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 | Ordena o resultado pelas propriedades fornecidas. 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 |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi utilizado.
Exemplos
Recuperando grupos de usuários habilitados
Recupere todos os grupos de usuários habilitados.
{
"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.