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ó
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.
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.

Consulteu [pàgina del grup d'usuaris](objecte#permissió) per obtindre una llista dels nivells d'accés del grup d'equips.| |limitSelects|integer|Limita el nombre de registres retornats per subseleccions.| |sortfield|string/array|Ordena el resultat segons les propietats donades.

Els valors possibles són:
usrgrpid,name.| |countOutput|boolean|Aquests paràmetres comuns a tots els mètodesget` 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.

Petició:

{
           "jsonrpc": "2.0",
           "method": "usergroup.get",
           "params": {
               "output": "extend",
               "status": 0
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "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
       }

Veieu també

Font

CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.