user.update

Opis

object user.update(object/array users)

Ta metoda umożliwia aktualizację istniejących użytkowników.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Siła hasła użytkownika jest weryfikowana zgodnie z regułami polityki haseł zdefiniowanymi przez Authentication API. Więcej informacji można znaleźć w sekcji Authentication API.

Parametry

(object/array) Właściwości użytkownika do zaktualizowania.

Właściwość userid musi być zdefiniowana dla każdego użytkownika, wszystkie pozostałe właściwości są opcjonalne. Zaktualizowane zostaną tylko przekazane właściwości, wszystkie pozostałe pozostaną bez zmian.

Oprócz standardowych właściwości użytkownika metoda akceptuje następujące parametry.

Parametr Typ Opis
current_passwd string Bieżące hasło użytkownika.

Wartość tego parametru może być pustym ciągiem znaków, jeśli użytkownik jest powiązany z katalogiem użytkowników.

Zachowanie parametru:
- tylko do zapisu
- wymagany, jeśli passwd obiektu User object jest ustawione i użytkownik zmienia własne hasło
usrgrps array Grupy użytkowników zastępujące istniejące grupy użytkownika.

Dla grup użytkowników musi być zdefiniowana tylko właściwość usrgrpid.
medias array Media użytkownika zastępujące istniejące, nieudostępnione media. Udostępnione media można pominąć podczas aktualizacji mediów.

Wartości zwracane

(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych użytkowników we właściwości userids.

Przykłady

Zmiana nazwy użytkownika

Zmień nazwę użytkownika na John Doe.

Żądanie:

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

Odpowiedź:

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

Zmiana roli użytkownika

Zmień rolę użytkownika.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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