Sidebar

usergroup.get

Beschrijving

integer/array gebruikersgroep.get(objectparameters)

De methode maakt het mogelijk om gebruikersgroepen op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
status integer Retourneer alleen gebruikersgroepen met de opgegeven status.

Raadpleeg de pagina met gebruikersgroepen voor een lijst met ondersteunde statussen.
userids string/array Retourneer alleen gebruikersgroepen die de opgegeven gebruikers bevatten.
usrgrpids string/array Retourneer alleen gebruikersgroepen met de opgegeven ID's.
selectTagFilters query Retourneer machtigingen op basis van gebruikersgroeptags in de eigenschap tag_filters.

Het heeft de volgende eigenschappen:
groupid - (tekenreeks) ID van de hostgroep;
tag - (tekenreeks) tagnaam;
value - (tekenreeks) tagwaarde.
selectUsers query Retourneer de gebruikers uit de gebruikersgroep in de eigenschap users.
selectRights query Retourneer gebruikersgroepsrechten in de eigenschap rights.

Het heeft de volgende eigenschappen:
permission - ( integer) toegangsniveau tot de hostgroep;
id - (tekenreeks) ID van de hostgroep.

Raadpleeg de gebruikersgroeppagina voor een lijst met toegangsniveaus om groepen te hosten.
limitSelects integer Beperkt het aantal records dat wordt geretourneerd door subselects.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: usrgrpid, name.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Ingeschakelde gebruikersgroepen ophalen

Haal alle ingeschakelde gebruikersgroepen op.

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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