user.update

Beschrijving

object user.update(object/array gebruikers)

Met deze methode kunnen bestaande gebruikers worden bijgewerkt.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

De sterkte van het gebruikerswachtwoord wordt gevalideerd volgens de wachtwoordbeleidsregels gedefinieerd door Authentication API. Zie Authenticatie API voor meer informatie.

Parameters

(object/array) Gebruikerskenmerken die moeten worden bijgewerkt.

Het userid-kenmerk moet worden gedefinieerd voor elke gebruiker, alle andere kenmerken zijn optioneel. Alleen de doorgegeven kenmerken worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard gebruikerskenmerken, accepteert de methode de volgende parameters.

Parameter Type Omschrijving
passwd string Wachtwoord van de gebruiker.

Kan een lege tekenreeks zijn als de gebruiker behoort tot of alleen wordt verplaatst naar groepen die LDAP-toegang hebben.
usrgrps array Gebruikers groepen om bestaande gebruikersgroepen te vervangen.

De gebruikersgroepen moeten het kenmerk usrgrpid gedefinieerd hebben.
medias array Te vervangen gebruikersmedia.
user_medias
(verouderd)
array Deze parameter is verouderd, gebruik in plaats daarvan medias.
Gebruikersmedia om bestaande media te vervangen.

Retourwaarden

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

Voorbeelden

Een gebruiker hernoemen

Hernoem een gebruiker naar John Doe.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "user.update",
           "params": {
               "userid": "1",
               "name": "John",
               "surname": "Doe"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

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

Gebruikersrol wijzigen

Verander een rol van een gebruiker.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "user.update",
           "params": {
               "userid": "12",
               "roleid": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": {
               "userids": [
                   "12"
               ]
           },
           "id": 1
       }

Zie ook

Bron

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