user.update

Description

object user.update(object/array users)

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

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir User roles pour plus d’informations.

La robustesse du mot de passe utilisateur est validée conformément aux règles de politique de mot de passe définies par l’Authentication API. Voir Authentication API 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
current_passwd string Mot de passe actuel de l’utilisateur.

La valeur de ce paramètre peut être une chaîne vide si l’utilisateur est lié à un répertoire d’utilisateurs.

Comportement du paramètre :
- écriture seule
- obligatoire si passwd de l’objet User est défini et que l’utilisateur modifie son propre mot de passe
usrgrps array Groupes d’utilisateurs remplaçant les groupes d’utilisateurs existants.

Seule la propriété usrgrpid doit être définie pour les groupes d’utilisateurs.
medias array Médias utilisateur remplaçant les médias existants non provisionnés. Les médias provisionnés peuvent être omis lors de la mise à jour des médias.

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"
    },
    "id": 1
}

Réponse :

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

Modification du rôle d’un utilisateur

Modifier le rôle d’un utilisateur.

Requête:

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

Réponse :

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

Voir également

Source

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