user.out

תיאור

string/object user.logout(array)

שיטה זו מאפשרת להתנתק מה-API ומבטלת את הזרם אסימון אימות.

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

פרמטרים

(מערך) השיטה מקבלת מערך ריק.

החזר ערכים

(בוליאנית) מחזירה true אם המשתמש התנתק בהצלחה.

דוגמאות

מתנתק

התנתק מהממשק API.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "user.logout",
            "params": [],
            "מזהה": 1,
            "auth": "16a46baf181ef9602e1687f3110abf8a"
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": נכון,
            "מזהה": 1
       }

מידע נוסף

user.login

מקור

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

Documentation