role.update

Beschrijving

object role.update(object/array roles)

Met deze methode kunt u bestaande rollen bijwerken.

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

Parameters

(object/array) Roleigenschappen moeten worden bijgewerkt.

De eigenschap roleid moet worden gedefinieerd voor elke rol, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, allemaal andere blijven ongewijzigd.

Naast de standaard roleigenschappen de methode accepteert de volgende parameters.

Parameter Type Beschrijving
rules array Access rules om de huidige toegangsregels die aan de rol zijn toegewezen te vervangen.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte rollen bevat onder de eigenschap roleids.

Voorbeelden

Uitschakelen van de mogelijkheid om scripts uit te voeren

Bijwerk rol met ID "5", schakel de mogelijkheid om scripts uit te voeren uit.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "role.update",
           "params": [
               {
                   "roleid": "5",
                   "rules": {
                       "actions": [
                           {
                               "name": "execute_scripts",
                               "status": "0"
                           }
                       ]
                   }
               }
           ],
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "roleids": [
                   "5"
               ]
           },
           "id": 1
       }

Beperken van toegang tot API

Bijwerk rol met ID "5", verbied het oproepen van alle "create", "update" of "delete" methoden.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "role.update",
           "params": [
               {
                   "roleid": "5",
                   "rules": {
                       "api.access": "1",
                       "api.mode": "0",
                       "api": ["*.create", "*.update", "*.delete"]
                   }
               }
           ],
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "roleids": [
                   "5"
               ]
           },
           "id": 1
       }

Bron

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