ניהול זהויות SmartSense באמצעות SCIM v2
כדי להקל על ניהול המשתמשים ב-SmartSense, SmartSense מספקת מערך של נקודות קצה התואמות לתקן SCIM גרסה 2.
עיון בתוצאות
על פי RFC 7644 של SCIM, כל נקודת קצה המחזירה רשימת נתונים כפופה לחלוקה לעמודים. מידע על החלוקה לעמודים נכלל בכל התגובות המחולקות לעמודים, כדלקמן.
שם | סוג | תיאור |
totalResults | המספר הכולל של התוצאות התואמות לשאילתת הלקוח. | |
startIndex | האינדקס (המתחיל ב-1) של התוצאה הראשונה בעמוד הנוכחי. | |
פריטים בדף | מספר התוצאות המוצגות בעמוד הנוכחי. |
סוגים ספציפיים של SCIM
אובייקטי SCIM והתכונות שלהם מוגדרים בתקן SCIM RFC 7643. להלן תיאור של סוגי ה-SCIM המשמשים ביישום ה-SCIM של SmartSense, וכן אופן השימוש בהם.
מטה
כל האובייקטים ב-SCIM מכילים אובייקט מטא. אובייקט זה אינו נדרש בפקודות PUT, POST או PATCH, אך יוחזר תמיד בפקודות GET.
שם | סוג | השתנות | תיאור |
סוג המשאב | מחרוזת | לקריאה בלבד | שם סוג המשאב המכיל. |
מקום | מחרוזת | לקריאה בלבד | כתובת URL שניתן להשתמש בה כדי לבצע בקשת GET לאובייקט. |
SmartSenseEnterpriseUser
SmartSenseEnterpriseUser (שכעת אינו בשימוש עוד ואינו נדרש, אך נשאר בתוקף לצורך תאימות לאחור) הוא הרחבה של סכימת המשתמש הארגוני הבסיסית של SCIM. SmartSenseEnterpriseUser מורכב משני תכונות.
שם | סוג | השתנות | תיאור |
מזהה תפקיד איש הקשר המוגדר כברירת מחדל | מחרוזת | קריאה וכתיבה | ContactRoleId שישמש בעת שיוך המשתמש לקבוצה. |
שם
שם | סוג | השתנות | תיאור |
שם פרטי | מחרוזת | קריאה וכתיבה | שם הפרטי של המשתמש. |
שם משפחה | מחרוזת | קריאה וכתיבה | שם המשפחה של המשתמש. |
דוא"ל
שם | סוג | השתנות | תיאור |
ערך | מחרוזת | קריאה וכתיבה | כתובת הדוא"ל של המשתמש. |
סוג | מחרוזת | קריאה וכתיבה | סוג כתובת הדוא"ל. יש לציין תמיד "עבודה". |
ראשוני | בוליאני | קריאה וכתיבה | ערך בוליאני המציין אם כתובת דוא"ל זו היא כתובת הדוא"ל הראשית של המשתמש. הערך צריך להיות תמיד "true". |
מספר טלפון
ניתן להגדיר למשתמשי SmartSense שני מספרי טלפון: אחד לשיחות קוליות ואחד להודעות SMS. יש להגדיר את "הסוג" של מספר טלפון להודעות SMS כ-"SMS". יש להגדיר את "הסוג" של מספר טלפון לשיחות קוליות כ-"קול".
שם | סוג | השתנות | תיאור |
ערך | מחרוזת | קריאה וכתיבה | מספר הטלפון של המשתמש. 1 |
סוג | מחרוזת | קריאה וכתיבה | סוג כתובת מספר הטלפון. צריך להיות "SMS" או "שיחה". |
ראשוני | בוליאני | קריאה וכתיבה | ערך בוליאני המציין אם מספר טלפון זה הוא מספר הטלפון הראשי של המשתמש. הערך צריך להיות תמיד "true". |
הערה: פורמטים מקובלים של מספרי טלפון:
- E.164: `+11234567890`
- RFC3966: `tel:+11234567890` או `tel:+1-123-456-7890`
-*פורמט בינלאומי: `+1(123)456-7890,` `+1-123-456-7890,` `+1.123.456.7890,` או `1 123 456 7890`
- פורמט לאומי:`123-456-7890,` `123.456.7890,` `(123)456-7890,` או `123 456 7890
*אםמספר בינלאומי עונה על אותה תבנית כמו מספר מקומי, הוא יישמר כמספר אמריקאי עם קידומת `+1`
ללא תלות בפורמט הקלט, SmartSense מאחסן את כל מספרי הטלפון בפורמט E.164 ומחזיר אותם כ-`+11234567890.`
פורמטים לא תקינים של מספרי טלפון לא יישמרו.
תפקיד איש הקשר
נקודות הקצה של 'תפקידי יצירת קשר' משמשות ליצירה ולעדכון של תפקידי יצירת קשר ממערכת SmartSense. תפקידי יצירת קשר מגדירים את הקשר שבין המשתמש לקבוצה. כאשר משתמש מוקצה לקבוצה, יש להקצות לו גם תפקיד יצירת קשר. תפקידי יצירת קשר אלה משמשים לקביעת מי יקבל התראה כאשר נכס נכנס למצב אזעקה.
ניתן להקצות תפקיד 'איש קשר' יחיד למשתמש עבור כל הקבוצות שאליהן הוא משויך, על ידי הגדרת השדה DefaultContactRoleId באובייקט SmartSenseEnterpriseUser.
ContactRoleObjectModel
שם | סוג | השתנות | תיאור |
id | מחרוזת | לקריאה בלבד | מזהה ייחודי ברמה העולמית של ContactRole. |
שם | מחרוזת | בלתי משתנה | שם תפקיד הקשר (ContactRole) המוצג ביישום SmartSense. |
תכונת סוג הקבוצה
יצירת ואחזור תכונות סוג הקבוצה שהוגדרו עבור החשבון שלך. ניתן להגדיר תכונות לקבוצות ב-SmartSense. לסוגי קבוצות שונים יהיו תכונות חובה ותכונות לא חובה שונות, בהתאם לתבנית הקבוצה (GroupTemplate) שהוקצתה להם. תכונות אלו משמשות לארגון בתוך יישום SmartSense.
מודל האובייקט GroupTypeAttribute
שם | סוג | השתנות | תיאור |
attributeID | מחרוזת | לקריאה בלבד | מזהה ייחודי לתכונה. |
שם התכונה | מחרוזת | לקריאה בלבד | שם התכונה המוצג ביישום SmartSense. |
סוג התכונה | מחרוזת | לקריאה בלבד | שם סוג הנתונים של התכונה. |
isRequired | בוליאני | לקריאה בלבד | ערך בוליאני המציין אם קבוצות מסוג זה חייבות לספק ערך לתכונה זו. |
סוג הקבוצה | מחרוזת | לקריאה בלבד | סוג הקבוצה שאליה שייך התכונה. |
קבוצות
נקודות הקצה של הקבוצות משמשות ליצירה, עדכון ומחיקה של קבוצות ממערכת SmartSense, וכן לניהול המשתמשים המשויכים אליהן. הקבוצות ב-SmartSense מאורגנות בעץ היררכי לפי סוג הקבוצה (GroupType). הקבוצות משמשות לארגון נכסים, והמשתמשים מוקצים לקבוצות באמצעות תפקיד איש הקשר (ContactRole). סכימת הקבוצה של SCIM מוגדרת בסעיף 4.2 של תקן RFC 7643.
מודל האובייקטים הקבוצתי
SmartSense עושה שימוש בכל המאפיינים של מודל SCIM Group ומרחיב אותו.
שם | סוג | השתנות | תיאור |
id | מחרוזת | לקריאה בלבד | מזהה ייחודי ברמה העולמית עבור הקבוצה. |
externalid | מחרוזת | קריאה וכתיבה | מזהה המסופק על ידי הלקוח. תכונה זו אינה משמשת את יישום SmartSense והיא מיועדת אך ורק למעקב חיצוני. |
parentid | מחרוזת | בלתי משתנה | מזהה הקבוצה האם של הקבוצה. |
displayName | מחרוזת | קריאה וכתיבה | שם הקבוצה כפי שהוא מוצג ביישום SmartSense. |
סוג | בלתי משתנה | סוג הקבוצה. | |
תכונות | מערך | קריאה וכתיבה | רשימת התכונות הקשורות לקבוצה. |
חברים | מערך | קריאה וכתיבה | רשימה של משתמשים השייכים לקבוצה. ראה 'חברים'. |
מטה | לקריאה בלבד | מידע המטא על הקבוצה. |
מודל האובייקטים של החברים
שם | סוג | השתנות | תיאור |
שסתום | מחרוזת | בלתי משתנה | מזהה החבר. על המזהה להיות UserId תקף. |
contactRoleId | מחרוזת | בלתי משתנה | ה-ContactRoleId של חבר הקבוצה. |
סוג | מחרוזת | בלתי משתנה | סוג האובייקט החבר. |
$ref | מחרוזת | בלתי משתנה | הפניה לכתובת URL שניתן להשתמש בה כדי לבצע בקשת GET עבור החבר. |
סוג המשאב
קבל את סוגי המשאבים של SCIM עבור המשאבים שהוגדרו ב-SmartSense. סוגי המשאבים של SCIM מוגדרים ונדרשים על פי סעיף 6 בתקן RFC 7643.
מודל האובייקטים של ResourceType
שם | סוג | השתנות | תיאור |
id | מחרוזת | לקריאה בלבד | מזהה עבור ResourceType. |
שם | מחרוזת | לקריאה בלבד | שם המשאב. |
תיאור | מחרוזת | לקריאה בלבד | תיאור של המשאב. |
נקודת קצה | מחרוזת | לקריאה בלבד | נקודת הסיום העיקרית לאחזור משאבים מסוג ResourceType זה. |
סכימה | מחרוזת | לקריאה בלבד | הסכימה הבסיסית ResourceTypes. |
הרחבת סכימה | לקריאה בלבד | רשימה של סכמות המרחיבות את הסכמה הבסיסית עבור ResourceType. | |
מטה | לקריאה בלבד | מידע המטה עבור ResourceType. |
מודל האובייקטים של SchemaExtension
שם | סוג | השתנות | תיאור |
סכימה | מחרוזת | לקריאה בלבד | הרחבת הסכימה שמוחלת. |
חובה | בוליאני | לקריאה בלבד | האם יש צורך להפעיל את התוסף בעת האינטראקציה עם המערכת. |
משתמשים
נקודות הקצה של המשתמשים משמשות ליצירה, עדכון ומחיקה של משתמשים ממערכת SmartSense. משתמשי SmartSense שנוצרו באמצעות ממשק ה-API של SCIM יכולים להתחבר למערכת SmartSense אך ורק באמצעות אינטגרציית SSO של SAML. SmartSense משתמשת רק בתת-קבוצה של תכונות המשתמש הזמינות ב-SCIM. סכימת המשתמש המלאה של SCIM מוגדרת בסעיף 4.1 של תקן RFC 7643.
מודל האובייקטים של המשתמש
שם | סוג | השתנות | תיאור |
id | מחרוזת | לקריאה בלבד | מזהה ייחודי של המשתמש ברמה העולמית. |
externalid | מחרוזת | קריאה וכתיבה | מזהה המסופק על ידי הלקוח. תכונה זו אינה משמשת את יישום SmartSense והיא מיועדת אך ורק למעקב חיצוני. |
שם משתמש | מחרוזת | בלתי משתנה | מזהה ייחודי של המשתמש, המורכב ממחרוזת תווים. |
פעיל | בוליאני | קריאה וכתיבה | ערך בוליאני המציין אם למשתמש מותר לגשת למערכת. |
סוג המשתמש | תפקיד גישה | קריאה וכתיבה | מחרוזת המזהה את ההרשאות של המשתמש במערכת. |
שם | קריאה וכתיבה | אובייקט מורכב המכיל את השם הפרטי ושם המשפחה של המשתמש. | |
מיילים | מערך | קריאה וכתיבה | רשימת כתובות דוא"ל. SmartSense מקבלת ומחזירה רק כתובת דוא"ל אחת מתוך הרשימה הזו. |
מספרי טלפון | מערך | קריאה וכתיבה | רשימת מספרי טלפון. SmartSense תומך בשני סוגי מספרי טלפון: SMS ושיחות קוליות. |
קבוצות | מערך | לקריאה בלבד | רשימה של הקבוצות שאליהן משתייך המשתמש. |
מטה | לקריאה בלבד | מידע המטא על המשתמש. |
תיעוד API אינטראקטיבי
לתיעוד מפורט של נקודות הקצה וליכולת לבדוק קריאות API באופן ישיר, בקרו בתיעוד Swagger שלנו:
ממשק Swagger מספק:
תבניות בקשה ותגובה
בדיקת ממשקי API אינטראקטיבית