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

role.update

Beschrijving

object role.update(object/array-rollen)

Met deze methode kunnen bestaande rollen worden bijgewerkt.

Deze methode is alleen beschikbaar voor het gebruikerstype Superbeheerder. Machtigingen om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zien Gebruiker rollen 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

Mogelijkheid om scripts uit te voeren uitschakelen

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

Verzoek:

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

Antwoord:

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

Toegang tot API beperken

Rol bijwerken met ID "5", weigeren om "create", "update" of "delete" aan te roepen methoden.

Verzoek:

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

Antwoord:

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

Bron

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