Documentation
Table of Contents
user.update
Description
object user.update(object/array users)
Cette méthode permet de mettre à jour les utilisateurs existants.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
La force du mot de passe de l'utilisateur est validée selon les règles de politique de mot de passe définies par l'API d'authentification. Voir l'API d'authentification pour plus d'informations.
Paramètres
(object/array) Propriétés de l'utilisateur à 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 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 si l'utilisateur appartient ou est déplacé uniquement vers des groupes disposant d'un accès LDAP. |
| usrgrps | array | Groupes d'utilisateurs en remplacement des groupes existants. Les groupes d'utilisateurs doivent avoir la propriété usrgrpid définie. |
| medias | array | Medias utilisateur des médias existants. |
| user_medias (obsolète) |
array | Ce paramètre est obsolète, veuillez utiliser medias à la place.Media utilisateur pour remplacer le média existant. |
Valeurs retournées
(object) Renvoie un objet contenant les ID des utilisateurs mis à jour sous la propriété userids.
Exemples
Renommer un utilisateur
Renommez 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 :
Modification du rôle de l'utilisateur
Modifier le rôle d'un utilisateur.
Requête :
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
Voir également
Source
CUser::update() dans ui/include/classes/api/services/CUser.php.