usergroup.delete

Beschrijving

object usergroup.delete(array userGroupIds)

Deze methode maakt het mogelijk om gebruikersgroepen te verwijderen.

Geïntegreerde gebruikersgroepen (de gebruikersgroep die is gespecificeerd voor disabled_usrgrpid in Authenticatie) kunnen niet worden verwijderd.

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

Parameters

(array) ID's van de gebruikersgroepen die moeten worden verwijderd.

Retourwaarden

(object) Retourneert een object met de ID's van de verwijderde gebruiker groepen onder de eigenschap usrgrpids.

Voorbeelden

Meerdere gebruikersgroepen verwijderen

Verwijder twee gebruikersgroepen.

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "usergroup.delete",
    "params": [
        "20",
        "21"
    ],
    "id": 1
}

Reactie:

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

Bron

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