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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| 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 | string/array | Retorna nom¨¦s els grups d'usuaris que contenen els usuaris especificats. |
| usrgrpids | string/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. T¨¦ les propietats seg¨¹ents: groupid - (cadena ) ID del grup d'equips;etiqueta - nom de l'etiqueta (cadena);valor - valor de l'etiqueta (cadena). |
| selectUsers | query | Retorna els usuaris del grup d'usuaris a la propietat usuaris. Veieu user.get per obtindre les restriccions basades en el tipus d'usuari. |
| selectRights | query | Retorna els permisos del grup d'usuaris a la propietat permisos. T¨¦ les propietats seg¨¹ents: ' perm¨ªs - (enter) nivell d'acc¨¦s del grup d'equips;id- (cadena) ID del grup d'equips.usrgrpid,name,usrgrpid,us_access_status.extend.| |sortfield|string/array|Ordena el resultat segons les propietats donades.usrgrpid,name`. |
| countOutput | boolean | Aquests par¨¤metres es descriuen amb detall a la p¨¤gina comentaris 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 |
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
Recuperar tots els grups d'usuaris actius.
±Ê±ð³Ù¾±³¦¾±¨®:
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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
}Veieu tamb¨¦
Font
CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.