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": "Áú»¢¶Ä²© 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.