עדכון משתמש

תיאור

object user.update(משתמשי אובייקט/מערך)

שיטה זו מאפשרת לעדכן משתמשים קיימים.

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

עוצמת סיסמת המשתמש מאומתת בהתאם ל כללי מדיניות סיסמאות שהוגדרו על ידי Authentication API. ראה אימות API למידע נוסף מֵידָע.

פרמטרים

(אובייקט/מערך) יש לעדכן מאפייני משתמש.

יש להגדיר את המאפיין 'userid' עבור כל משתמש, כל השאר נכסים הם אופציונליים. רק המאפיינים שעברו יעודכנו, כולם אחרים יישארו ללא שינוי.

בנוסף למאפייני משתמש סטנדרטיים, השיטה מקבל את הפרמטרים הבאים.

פרמטר סוג תיאור
passwd string סיסמת המשתמש.

יכולה להיות מחרוזת ריקה אם המשתמש שייך או מועבר רק לקבוצות שיש להן גישת LDAP.
usrgrps array משתמש קבוצות כדי להחליף קבוצות משתמשים קיימות.

על קבוצות המשתמשים להיות מוגדר המאפיין usrgrpid.
medias array מדיה משתמש להחלפת מדיה קיימת.
user_medias
(הוצא משימוש)
מערך פרמטר זה הוצא משימוש, אנא השתמש ב-'medias' במקום זאת.
משתמש media כדי להחליף מדיה קיימת.

החזר ערכים

(אובייקט) מחזירה אובייקט המכיל את המזהים של המשתמשים המעודכנים תחת המאפיין 'משתמשים'.

דוגמאות

שינוי שם של משתמש

שנה שם משתמש לג'ון דו.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "user.update",
            "params": {
                "userid": "1",
                "name": "ג'ון",
                "surname": "איילה"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": {
                "משתמשים": [
                    "1"
                ]
            },
            "מזהה": 1
       }

שינוי תפקיד משתמש

שנה תפקיד של משתמש.

בַּקָשָׁה:

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

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": {
                "משתמשים": [
                    "12"
                ]
            },
            "מזהה": 1
       }

מידע נוסף

מקור

CUser::update()‎ בתוך ui/include/classes/api/services/CUser.php.