user.update

Beschreibung

object user.update(object/array users)

Diese Methode ermöglicht die Aktualisierung bestehender Benutzer.

Diese Methode ist für Benutzer jedes Typs verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Siehe Benutzerrollen für weitere Informationen.

Die Stärke des Benutzerpassworts wird gemäß den durch die Authentication API definierten Regeln der Passwortrichtlinie validiert. Siehe Authentication API für weitere Informationen.

Parameter

(object/array) Zu aktualisierende Benutzereigenschaften.

Die Eigenschaft userid muss für jeden Benutzer definiert sein, alle anderen Eigenschaften sind optional. Nur die übergebenen Eigenschaften werden aktualisiert, alle anderen bleiben unverändert.

Zusätzlich zu den Standard-Benutzereigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
current_passwd string Aktuelles Passwort des Benutzers.

Der Wert dieses Parameters kann eine leere Zeichenfolge sein, wenn der Benutzer mit einem Benutzerverzeichnis verknüpft ist.

Parameter behavior:
- write-only
- required if passwd of User object is set and user changes own user password
usrgrps array Benutzergruppen zum Ersetzen bestehender Benutzergruppen.

Für die Benutzergruppen darf nur die Eigenschaft usrgrpid definiert sein.
medias array Benutzermedien zum Ersetzen vorhandener, nicht bereitgestellter Medien. Bereitgestellte Medien können beim Aktualisieren von Medien weggelassen werden.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der aktualisierten Benutzer unter der Eigenschaft userids enthält.

Beispiele

Umbenennen eines Benutzers

Benennen Sie einen Benutzer in John Doe um.

Anfrage:

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

Antwort:

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

Ändern der Benutzerrolle

Ändern Sie die Rolle eines Benutzers.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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