object user.update(object/array users)
Deze methode maakt het mogelijk om bestaande gebruikers bij te werken.
Deze methode is beschikbaar voor gebruikers van elk type. Permissies om de methode te gebruiken kunnen worden ingetrokken in de gebruikersrol instellingen. Zie Gebruikersrollen voor meer informatie.
De sterkte van het wachtwoord van de gebruiker wordt gevalideerd volgens de regels van het wachtwoordbeleid dat is gedefinieerd door de Authenticatie API. Zie Authenticatie API voor meer informatie.
(object/array)
Gebruikerseigenschappen die moeten worden bijgewerkt.
De eigenschap userid
moet worden gedefinieerd voor elke gebruiker, alle andere eigenschappen zijn optioneel. Alleen de meegegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.
Naast de standaard gebruikerseigenschappen accepteert de methode de volgende parameters.
Parameter | Type | Beschrijving |
---|---|---|
current_passwd | string | Het huidige wachtwoord van de gebruiker. De waarde van deze parameter kan een lege tekenreeks zijn als de gebruiker is gekoppeld aan een gebruikersmap. Gedrag van de parameter: - alleen schrijven - verplicht als passwd van gebruikersobject is ingesteld en de gebruiker zijn eigen wachtwoord wijzigt |
usrgrps | array | Gebruikers groepen om bestaande gebruikersgroepen te vervangen. De gebruikersgroepen moeten de eigenschap usrgrpid gedefinieerd hebben. |
medias | array | Gebruikersmedia om bestaande media te vervangen. |
(object)
Retourneert een object dat de ID's van de bijgewerkte gebruikers bevat onder de eigenschap userids
.
Hernoem een gebruiker naar John Doe.
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "1",
"name": "John",
"surname": "Doe"
},
"id": 1
}
Reactie:
Wijzig de rol van een gebruiker.
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"id": 1
}
Reactie:
CUser::update() in ui/include/classes/api/services/CUser.php.