usergroup.create

Beschrijving

object usergroup.create(object/array userGroups)

Deze methode maakt het mogelijk om nieuwe gebruikersgroepen aan te maken.

Deze methode is alleen beschikbaar voor gebruikers van het type Superadmin. Toestemming om de methode aan te roepen kan worden ingetrokken in gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Gebruikersgroepen om aan te maken.

Naast de standaard eigenschappen van een gebruikersgroep, accepteert de methode de volgende parameters.

Parameter	Type	Beschrijving
hostgroup_rights	object/array	Hostgroep rechten om aan de gebruikersgroep toe te wijzen.
templategroup_rights	object/array	Sjabloongroep rechten om aan de gebruikersgroep toe te wijzen.
tag_filters	array	Rechten gebaseerd op tags om aan de gebruikersgroep toe te wijzen.
users	object/array	Gebruikers om toe te voegen aan de gebruikersgroep. De gebruiker moet de eigenschap `userid` gedefinieerd hebben.
rights (verouderd)	object/array	Deze parameter is verouderd, gebruik alstublieft `hostgroup_rights` of `templategroup_rights` in plaats daarvan. Rechten om aan de gebruikersgroep toe te wijzen.

Retourwaarden

(object) Retourneert een object dat de ID's van de aangemaakte gebruiker bevat groepen onder de eigenschap usrgrpids. De volgorde van de geretourneerde ID's komt overeen met de volgorde van de doorgegeven gebruikersgroepen.

Voorbeelden

Een gebruikersgroep aanmaken

Maak een gebruikersgroep Operation managers aan met geweigerde toegang tot hostgroep "2" en voeg een gebruiker eraan toe.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "usergroup.create",
           "params": {
               "name": "Operation managers",
               "hostgroup_rights": {
                   "id": "2",
                   "permission": 0
               },
               "users": [
                   {
                       "userid": "12"
                   }
               ]
           },
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
                   "20"
               ]
           },
           "id": 1
       }

Zie ook

Toestemming

Bron

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

Documentation