Documentation
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 do usuário. Consulte Funções do usuário para obter mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método oferece suporte aos parâmetros a seguir.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| status | integer | Retorne apenas grupos de usuários com o status fornecido. Consulte a página do grupo de usuários 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. Tem as seguintes propriedades: groupid - (string ) ID do grupo de hosts;tag - (string) nome da etiqueta;value - (string) valor da etiqueta. |
| selectUsers | query | Retorne os usuários do grupo de usuários na propriedade users. |
| selectRights | query | Retorne direitos de grupo de usuários em propriedade rights. Possui as seguintes propriedades: permission - nível de acesso (inteiro) ao grupo de hosts;id - (string) ID do grupo de hosts.Consulte a página do grupo de usuários 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. 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. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi usado.
Exemplos
Recuperando grupos de usuários habilitados
Recuperar todos os grupos de usuários habilitados.
Request:
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}Veja também
Fonte
CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.