user.update

Leírás

object user.update(object/array users)

Ez a módszer lehetővé teszi a meglévő felhasználók frissítését.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

A felhasználói jelszó erősségének ellenőrzése a Authentication API által meghatározott jelszóházirend-szabályok. Lásd: Hitelesítés API további információkért információ.

Paraméterek

(objektum/tömb) Frissítendő felhasználói tulajdonságok.

A "userid" tulajdonságot minden felhasználóhoz meg kell határozni, minden máshoz a tulajdonságok nem kötelezőek. Csak az átadott tulajdonságok frissülnek a többi változatlan marad.

A standard felhasználói tulajdonságok mellett a metódus elfogadja a következő paramétereket.

Paraméter Típus Leírás
passwd string Felhasználó jelszava.

Üres karakterlánc lehet, ha a felhasználó LDAP-hozzáféréssel rendelkező csoportokhoz tartozik, vagy csak olyan csoportokba került át.
usrgrps array Felhasználó csoportok a meglévő felhasználói csoportok lecseréléséhez.

A felhasználói csoportoknak meg kell adni az usrgrpid tulajdonságot.
medias array Felhasználói adathordozó a meglévő adathordozók cseréjéhez.

Visszatérési értékek

(object) Egy objektumot ad vissza, amely tartalmazza a frissített felhasználók azonosítóit a "felhasználói azonosítók" tulajdonság alatt.

Példák

Renaming a user

Rename a user to John Doe.

Request:

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

Response:

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

Changing user role

Change a role of a user.

Request:

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

Response:

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

Lásd még

Forrás

CUser::update() az ui/include/classes/api/services/CUser.php-ban.