user.update

Description

object user.update(object/array users)

Cette méthode permet de mettre à jour les utilisateurs existants.

Paramètres

(object/array) Propriétés des utilisateurs à mettre à jour.

La propriété userid doit être définie pour chaque utilisateur. Toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de l'utilisateur standard, la méthode accepte les paramètres suivants.

Paramètre	Type	Description
passwd	string	Mot de passe de l'utilisateur. Peut être une chaîne vide uniquement si l'utilisateur appartient à ou est déplacé vers des groupes disposant d'un accès LDAP.
usrgrps	array	Groupes d'utilisateurs pour remplacer les groupes d'utilisateurs existants. Les groupes d'utilisateurs doivent avoir la propriété `usrgrpid` définie.
user_medias	array	Médias pour remplacer les médias existants.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des utilisateurs mis à jour sous la propriété userids.

Exemples

Renommage d'un utilisateur

Renommage d'un utilisateur en John Doe.

Requête :

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

Réponse :

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

Source

CUser::update() dans frontends/php/include/classes/api/services/CUser.php.

Documentation

Sidebar

Table of Contents