משתמש.קבל

תיאור

integer/array user.get(אובייקט פרמטרים)

השיטה מאפשרת לאחזר משתמשים לפי הפרמטרים הנתונים.

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

פרמטרים

(object) פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

פרמטר סוג תיאור
mediaids string/array החזר רק משתמשים שמשתמשים במדיה הנתונה.
mediatypeids string/array החזר רק משתמשים שמשתמשים בסוגי המדיה הנתונים.
userids string/array החזר רק משתמשים עם המזהים הנתונים.
usrgrpids string/array החזר רק משתמשים השייכים לקבוצות המשתמשים הנתונות.
getAccess flag מוסיף מידע נוסף על הרשאות משתמש.

מוסיף את המאפיינים הבאים עבור כל משתמש:
gui_access - (מספר שלם) שיטת האימות הקדמי של המשתמש. עיין במאפיין gui_access של אובייקט קבוצת המשתמשים לקבלת רשימה של ערכים אפשריים.
debug_mode - (integer) מציין אם באגים מופעל עבור המשתמש. ערכים אפשריים: 0 - איתור באגים מושבת, 1 - איתור באגים מופעל.
users_status - (מספר שלם) מציין אם המשתמש מושבת. ערכים אפשריים: 0 - מופעל על ידי משתמש, 1 - מושבת על ידי משתמש.
selectMedias query החזרת מדיה המשמשת את המשתמש במאפיין medias.
selectMediatypes query החזרת סוגי מדיה המשמשים את המשתמש במאפיין mediatypes.
selectUsrgrps query החזרת קבוצות משתמשים שהמשתמש שייך אליהן במאפיין usrgrps.
selectRole query החזרת תפקיד משתמש במאפיין role.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: userid ו-username.
countOutput boolean הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled בוליאני
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

דוגמאות

מאחזר משתמשים

אחזר את כל המשתמשים המוגדרים.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "user.get",
            "params": {
                "output": "להרחיב"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "userid": "1",
                    "username": "מנהל",
                    "name": "Zabix",
                    "surname": "מנהל",
                    "url": "",
                    "autologin": "1",
                    "autologout": "0",
                    "lang": "en_GB",
                    "refresh": "0s",
                    "theme": "ברירת מחדל",
                    "attempt_failed": "0",
                    "attempt_ip": "",
                    "attempt_clock": "0",
                    "rows_per_page": "50",
                    "timezone": "ברירת מחדל",
                    "roleid": "3"
                },
                {
                    "userid": "2",
                    "username": "אורח",
                    "שם": "",
                    "שם משפחה": "",
                    "url": "",
                    "autologin": "0",
                    "autologout": "15 מ'",
                    "lang": "ברירת מחדל",
                    "refresh": "שנות ה-30",
                    "theme": "ברירת מחדל",
                    "attempt_failed": "0",
                    "attempt_ip": "",
                    "attempt_clock": "0",
                    "rows_per_page": "50",
                    "timezone": "ברירת מחדל",
                    "roleid": "4"
                },
                {
                    "userid": "3",
                    "username": "משתמש",
                    "name": "Zabix",
                    "surname": "משתמש",
                    "url": "",
                    "autologin": "0",
                    "autologout": "0",
                    "lang": "ru_RU",
                    "refresh": "15s",
                    "theme": "נושא אפל",
                    "attempt_failed": "0",
                    "attempt_ip": "",
                    "attempt_clock": "0",
                    "rows_per_page": "100",
                    "timezone": "ברירת מחדל",
                    "roleid": "1"
                }
            ],
            "מזהה": 1
       }

אחזור נתוני משתמש

אחזר נתונים של משתמש עם מזהה "12".

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "user.get",
            "params": {
                "output": ["userid", "username"],
                "selectRole": "להרחיב",
                "userids": "12"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
          "jsonrpc": "2.0",
          "תוצאה": [
              {
                  "userid": "12",
                  "username": "ג'ון",
                  "תפקיד": {
                      "roleid": "5",
                      "name": "מפעיל",
                      "סוג 1",
                      "readonly": "0"
                  }
              }
          ],
          "מזהה": 1
       }

ראה גם

מקור

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