This is a translation of the original English documentation page. Help us make it better.

usergroup.get

Beschrijving

integer/array usergroup.get(object parameters)

Deze methode maakt het mogelijk om gebruikersgroepen op te halen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode aan te roepen kan worden ingetrokken in de instellingen voor gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
status integer Geef alleen gebruikersgroepen weer met de opgegeven status.

Zie gebruikersgroep pagina voor een lijst van ondersteunde statussen.
userids string/array Geef alleen gebruikersgroepen weer die de opgegeven gebruikers bevatten.
usrgrpids string/array Geef alleen gebruikersgroepen weer met de opgegeven IDs.
selectTagFilters query Geef tag-gebaseerde permissies voor gebruikersgroepen weer in het tag_filters eigenschap.

Het heeft de volgende eigenschappen:
groupid - (string) ID van de hostgroep;
tag - (string) tag naam;
value - (string) tag waarde.
selectUsers query Geef de gebruikers van de gebruikersgroep weer in het users eigenschap.
selectHostGroupRights query Geef hostgroep rechten voor gebruikersgroepen weer in het hostgroup_rights eigenschap.

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

Zie gebruikersgroep pagina voor een lijst van toegangsniveaus tot hostgroepen.
selectTemplateGroupRights query Geef sjabloon groep rechten voor gebruikersgroepen weer in het templategroup_rights eigenschap.

Het heeft de volgende eigenschappen:
permission - (integer) toegangsniveau tot de sjabloon groep;
id - (string) ID van de sjabloon groep.

Zie gebruikersgroep pagina voor een lijst van toegangsniveaus tot sjabloon groepen.
limitSelects integer Beperkt het aantal records dat wordt teruggegeven door subselecties.
sortfield string/array Sorteer het resultaat op basis van de opgegeven eigenschappen.

Mogelijke waarden: usrgrpid, name.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get methoden worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)
query Deze parameter is verouderd, gebruik alstublieft selectHostGroupRights of selectTemplateGroupRights in plaats daarvan.
Geef gebruikersgroeprechten weer in het rights eigenschap.

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

Zie gebruikersgroep pagina voor een lijst van toegangsniveaus tot hostgroepen.

Is there anything else I can assist you with?

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Ophalen ingeschakelde gebruikersgroepen

Haal alle ingeschakelde gebruikersgroepen op.

Verzoek:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "usrgrpid": "7",
                   "name": "Zabbix-beheerders",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "8",
                   "name": "Gasten",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Ingeschakelde debugmodus",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "12",
                   "name": "Geen toegang tot de frontend",
                   "gui_access": "2",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "14",
                   "name": "Alleen lezen",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               },
               {
                   "usrgrpid": "18",
                   "name": "Weigeren",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0"
               }
           ],
           "id": 1
       }

Zie ook

Bron

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