Documentation
Table of Contents
usergroup.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
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.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| mfaids | ID/array | Retorna nom¨¦s els grups d'usuaris amb els m¨¨todes MFA donats. Comportament de la propietat: - ²¹»å³¾¨¨²õ per a usuaris de tipus Super admin (des de Áú»¢¶Ä²© 7.2.3) |
| 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. Des de Áú»¢¶Ä²© 7.2.3, 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": "Áú»¢¶Ä²© 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.