usergroup.update

Beschrijving

object gebruikersgroep.update(object/array gebruikersgroepen)

Met deze methode kunnen bestaande gebruikersgroepen 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) Gebruikersgroepeigenschappen moeten worden bijgewerkt.

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

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

Parameter Type Beschrijving
rights object/array Permissions om de huidige machtigingen te vervangen die aan de gebruikersgroep zijn toegewezen.
tag_filters array Op tags gebaseerde machtigingen om aan de groep toe te wijzen.
users object/array Users om toe te voegen aan de gebruikersgroep.

De gebruiker moet de eigenschap userid hebben gedefinieerd.

Retourwaarden

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

Voorbeelden

Een gebruikersgroep uitschakelen

Schakel een gebruikersgroep uit.

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "1"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Antwoord:

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

Zie ook

Bron

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