Documentation
Table of Contents
usergroup.get
Descripció
integer/array usergroup.get(object parameters)
El mètode permet recuperar grups d'usuaris segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| mfaids | ID/array | Retorna només els grups d'usuaris amb els mètodes MFA donats. Comportament de la propietat: - admès per a usuaris de tipus Super admin |
| mfa_status | integer | Retorna només els grups d'usuaris amb l'estat MFA donat. Veieu la pàgina de grups d'usuaris per tindre una llista d'estats admesos. |
| status | integer | Retorna només els grups d'usuaris amb l'estat donat. Consulteu la pàgina de grup d'usuaris per obtindre una llista d'estats admesos. |
| userids | ID/array | Retorna només els grups d'usuaris que contenen els usuaris especificats. |
| usrgrpids | ID/array | Retorna només els grups d'usuaris amb els ID donats. |
| selectTagFilters | query | Retorna els permisos basats en etiquetes de grup d'usuaris a la propietat tag_filters. |
| selectUsers | query | Retorna els usuaris del grup d'usuaris a la propietat users. |
| selectHostGroupRights | query | Retorna els permisos del grup d'usuaris del grup de permisos a la propietat hostgroup_rights.Consulteu pàgina del grup d'usuaris per obtindre una llista dels nivells d'accés del grup d'equips. |
| selectTemplateGroupRights | query | Retorna els permisos del grup de permisos a la propietat templategroup_rights.Consulteu la pàgina del grup d'usuaris per obtindre una llista dels nivells d'accés del grup de plantilles. |
| limitSelects | integer | Limita el nombre de registres retornats per subseleccions. |
| output | query | Propietats de l'objecte grup d'usuaris que han de retornar. Els usuaris de tipus Admin i User només poden recuperar les propietats següents: usrgrpid, name, gui_accessdebu,usaccessdebu.extend.| |sortfield|string/array|Ordena el resultat segons les propietats donades.usrgrpid,name`. |
| countOutput | boolean | Aquests paràmetres es descriuen en detall a la pàgina comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar els grups d'usuaris actius
Recupera tots els grups d'usuaris actius.
{
"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
}Veieu també
Font
CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.