usergroup.update

Beschrijving

object usergroup.update(object/array userGroups)

Deze methode maakt het mogelijk om bestaande gebruikersgroepen bij te werken.

Deze methode is alleen beschikbaar voor gebruikers van het type Superadmin. Toestemmingen om de methode te gebruiken kunnen worden ingetrokken in gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Gebruikersgroepseigenschappen die moeten worden bijgewerkt.

De eigenschap usrgrpid moet worden gedefinieerd voor elke gebruikersgroep, alle andere eigenschappen zijn optioneel. Alleen de opgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard eigenschappen van gebruikersgroepen, accepteert de methode de volgende parameters.

Parameter	Type	Beschrijving
hostgroup_rights	object/array	Hostgroep rechten om de huidige rechten die aan de gebruikersgroep zijn toegewezen te vervangen.
templategroup_rights	object/array	Templategroep rechten om de huidige rechten die aan de gebruikersgroep zijn toegewezen te vervangen.
tag_filters	array	Tag-gebaseerde rechten 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 in plaats daarvan `hostgroup_rights` of `templategroup_rights`. Rechten om aan de gebruikersgroep toe te wijzen.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte gebruiker bevat groepen onder de eigenschap usrgrpids.

Voorbeelden

Het inschakelen van een gebruikersgroep en het bijwerken van rechten

Schakel een gebruikersgroep in en geef deze lees-schrijftoegang tot hostgroepen "2" en "4".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "0",
               "hostgroup_rights": [
                   {
                       "id": "2",
                       "permission": 3
                   },
                   {
                       "id": "4",
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

Reactie:

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

Zie ook

Toestemming

Bron

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

Documentation