הקצאת משתמשים וקבוצות באמצעות SCIM

ה-API של Notion ל-SCIM מאפשר לך לעשות את הדברים הבאים:

• יצירה והסרה של חברים בסביבת העבודה שלך.

• עדכון פרטי הפרופיל של חבר.

• אחזור החברים בסביבת העבודה שלך.

• חיפוש חברים לפי אימייל או שם.

• יצירה והסרה של קבוצות בסביבת העבודה שלך.

• הוספה והסרה של חברים בקבוצה.

• אחזור הקבוצות בסביבת העבודה שלך.

• חיפוש קבוצות לפי שם.

אנחנו תומכים כרגע ב-Okta, ב-OneLogin, ב-Rippling וביישומי SCIM מותאמים אישית. אם אתם משתמשים בספק זהות אחר, אנא עדכנו אותנו. ראו הוראות להגדרת ספק זהות עבור אפליקציות ספציפיות כאן →

כדי להשתמש ב-SCIM עם Notion:

• סביבת העבודה שלך חייבת להיות בתוכנית Enterprise.

• ספק הזהות (IdP) שלך חייב לתמוך בפרוטוקול SAML 2.0. ראו הוראות להגדרת ספק זהות עבור אפליקציות ספציפיות כאן →

• בעל סביבת עבודה חייב להגדיר SCIM עבור סביבת העבודה ב-Notion.

• עליך לאמת בעלות על דומיין אימייל אם ברצונך להשתמש ב-SCIM כדי לשנות את השם או את כתובת האימייל של משתמש. למידע נוסף על אימות דומיין →

רק בעלי ארגון בתוכנית Enterprise יכולים להפיק ולהציג אסימוני SCIM API. כדי ליצור אסימון SCIM API:

1. פתח את בורר סביבת העבודה ובחר ניהול ארגון. ייתכן שתצטרך להגדיר ארגון תחילה אם עדיין לא עשית זאת. למידע נוסף כאן →

2. בכרטיסייה כללי של בקרות ברמת הארגון שלך, בחר ב-> לצד הקצאת SCIM.

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

בנוסף, אסימונים פעילים יכולים להיבטל על ידי כל בעלי סביבת העבודה. לביטול אסימון, יש ללחוץ על ה-🗑 לצד האסימון המתאים.

אם אסימון מבוטל, תצטרכו להחליף אותו בכל אינטגרציה קיימת.

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

כדי לשלוט בשאלה אם משתמשים יקבלו הזמנות לסביבת עבודה ולקבוצות באמצעות אימייל בעת הקצאה על ידי SCIM, בעלי ארגון בתוכנית Enterprise יכולים:

1. לפתוח את מחליף סביבת העבודה ולבחור ב-ניהול הארגון.

2. בכרטיסייה כללי, יש להפעיל את דיכוי הודעות אימייל של הזמנה מהקצאת SCIM אם אינכם מעוניינים לשלוח הודעות אימייל למשתמשים.

כדי להקצות חבר/ה מוגבל/ת באמצעות SCIM, עליך להגדיר את מאפיין ה-'role' של SCIM ל-'restricted_member':

\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" | \"restricted_member\" }

כדי להעביר אורח דף ל-חבר/ה מוגבל/ת באמצעות SCIM, עליך להשתמש ב-POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • אחזור תיאור של תכונות מפרט ה-SCIM הזמינות.

  • מוגדר ב-סעיף 5 של מפרט פרוטוקול SCIM.

• GET /ResourceTypes

  • GET

  • אחזור רשימה של סוגי משאבי SCIM הזמינים.

  • מוגדר ב-סעיף 6 של מפרט פרוטוקול SCIM.

הטבלה שלהלן מפרטת את המיפוי בין מאפייני משתמש SCIM לבין שדות פרופיל משתמש ב-Notion. בעלי ארגון בוחרים אילו מאפיינים לשלוח ל-Notion ועשויים לעדכן מאפיינים כאלה בכל עת. Notion מעבדת את המאפיינים שאתם שולחים דרך ה-API של Notion SCIM כדי לשפר את החוויה של הקצאה וניהול של משתמשים וקבוצות.

• GET /Users

  • GET

  • אחזור רשימה מדורגת של חברי סביבת עבודה.

  • ניתן לבצע מיספור דפים באמצעות הפרמטרים startIndex ו-count. יש לקחת בחשבון ש-startIndex מתחיל ב-1 והערך המקסימלי עבור count הוא 100.

  • ניתן לסנן את התוצאות באמצעות הפרמטר filter. המאפיינים התקינים לסינון הם אימייל, given_name ו-family_name, לדוגמה GET

  • שים לב ש-given_name ו-family_name תלויים ברישיות (case sensitive). כתובת האימייל מומרת לאותיות קטנות.

• GET /Users/

  • GET

  • אחזור חבר סביבת עבודה ספציפי לפי מזהה המשתמש שלו ב-Notion. זה יהיה UUID בן 32 תווים בפורמט הבא: 00000000-0000-0000-0000-000000000000.

  • שים לב ש-meta.created ו-meta.lastModified אינם משקפים ערכי חותמת זמן משמעותיים.

• POST /Users

  • POST

  • אם למשתמש/ת שאת/ה מוסיף/ה כבר יש חשבון משתמש/ת ב-Notion עם אותה כתובת אימייל, הוא/היא יתווסף/תווסף לסביבת העבודה שלך.

  • אם המשתמש/ת אינו/ה קיים/ת, קריאה זו תיצור משתמש/ת Notion חדש/ה ולאחר מכן תוסיף אותו/אותה לסביבת העבודה שלך. הוא/היא ימופה/תמופה לפרופיל המשתמש/ת ב-Notion שנוצר/ה.

  • ה-API של SCIM יקרא את מאפיין תמונת הפרופיל בעת יצירת משתמש/ת, אך לא בעדכונים עתידיים.

• PATCH /Users/

  • PATCH

  • עדכון באמצעות סדרה של פעולות, והחזרת רשומת המשתמש/ת המעודכנת.

• PUT /Users/

  • PUT

  • עדכון, והחזרת רשומת המשתמש/ת המעודכנת.

• DELETE /Users/

  • DELETE

  • הסרת משתמש/ת מסביבת העבודה שלך. המשתמש/ת ינותק/תנותק מכל ההפעלות הפעילות.

    • לא ניתן למחוק חשבון משתמש/ת באמצעות SCIM. מחיקת חשבון חייבת להתבצע באופן ידני.

    • ניתן להסיר משתמש/ת מסביבת העבודה שלך גם על ידי הגדרת מאפיין המשתמש/ת active ל-false באמצעות שליחת בקשת PATCH /Users/ או PUT /Users/.

    • לא ניתן להסיר את בעל/ת סביבת העבודה שיצר/ה את אסימון הבוט של SCIM דרך ה-API. כאשר בעל/ת סביבת עבודה מוסר/ת דרך ה-API של SCIM, כל אסימון שיצר/ה יבוטל וכל אינטגרציה המשתמשת בבוט זה תפסיק לעבוד.

• GET /Groups

  • GET

  • אחזור רשימה מפוצלת לדפים של קבוצות סביבת עבודה.

  • ניתן לבצע פיצול לדפים באמצעות הפרמטרים startIndex ו-count. שים לב ש-startIndex מתחיל ב-1 וערכו המקסימלי של count הוא 100, למשל GET

    • אם לא נעשה שימוש בפיצול לדפים, יוחזרו לכל היותר 100 קבוצות סביבת עבודה בבקשה.

  • ניתן לסנן את התוצאות באמצעות הפרמטר filter. ניתן לסנן קבוצות לפי מאפיין ה-displayName שלהן, למשל GET

• GET /Groups/

  • GET

  • אחזור קבוצת סביבת עבודה ספציפית לפי מזהה הקבוצה שלה ב-Notion. זה יהיה UUID בן 32 תווים בפורמט הבא: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • יצירת קבוצת סביבת עבודה חדשה.

• PATCH /Groups/

  • PATCH

  • עדכון קבוצת סביבת עבודה באמצעות סדרה של פעולות.

• PUT /Groups/

  • PUT

  • עדכון קבוצת סביבת עבודה.

• DELETE /Groups/

  • DELETE

  • מחיקת קבוצת סביבת עבודה.