توفير المستخدمين والمجموعات باستخدام SCIM

تسمح لك واجهة برمجة تطبيقات SCIM الخاصة بـ Notion بالقيام بما يلي:

• إنشاء أعضاء في مساحة عملك وإزالتهم.

• تحديث معلومات ملف تعريف العضو.

• استرداد الأعضاء في مساحة عملك.

• البحث عن الأعضاء عن طريق البريد الإلكتروني أو الاسم.

• إنشاء المجموعات وإزالتها في مساحة العمل الخاصة بك.

• إضافة أعضاء إلى مجموعة وإزالتهم منها.

• استرداد المجموعات في مساحة عملك.

• البحث عن المجموعات بالاسم.

نحن ندعم حالياً Okta وOneLogin وRippling وتطبيقات SCIM المخصصة. إذا كنت تستخدم مزود هوية آخر، فيرجى إخبارنا بذلك. راجع تعليمات إعداد مزود الهوية لتطبيقات محددة هنا ←

لاستخدام SCIM مع Notion:

• يجب أن تكون مساحة العمل الخاصة بك على الخطة المؤسسية.

• يجب أن يدعم مزود الهوية (IdP) الخاص بك بروتوكول SAML 2.0. راجع تعليمات إعداد مزود الهوية لتطبيقات محددة هنا ←

• يجب على مالك مساحة العمل تكوين SCIM لمساحة عمل Notion.

• يجب أن تكون قد تحققت من ملكية نطاق بريد إلكتروني إذا كنت ترغب في استخدام SCIM لتعديل اسم المستخدم أو عنوان بريده الإلكتروني. تعرّف على المزيد حول التحقق من النطاق →

يمكن فقط لـ مالكي المؤسسات في الخطة المؤسسية إنشاء وعرض رموز SCIM API المميزة. لإنشاء رمز SCIM API مميز:

1. افتح مبدل مساحة عمل وحدد إدارة المؤسسة. قد تحتاج إلى إعداد المؤسسة أولاً إذا لم تقم بذلك بالفعل. تعرف على المزيد هنا ←

2. في علامة التبويب عام من عناصر التحكم على مستوى مؤسستك، حدد > بجوار توفير SCIM.

عندما يغادر مالك مساحة العمل أو يتم تغيير دوره، سيتم إلغاء رمزه المميز. عند حدوث ذلك، تُرسل رسالة آلية إلى باقي مالكي مساحة العمل لإخطارهم بضرورة استبدال الرمز المُلغى.

بالإضافة إلى ذلك، يمكن إلغاء الرموز المميزة النشطة من قبل أي من مالكي مساحة عمل. لإلغاء رمز مميز، انقر فوق 🗑 بجوار الرمز المميز المعني.

إذا تم إلغاء رمز مميز، فستحتاج إلى استبداله في أي عمليات تكامل حالية.

يتم تعطيل أي تكامل SCIM وتوفير المستخدمين المعتمدين على الرمز المميز المُلغى حتى يتم استبداله برمز مميز نشط.

للتحكم فيما إذا كان المستخدمون سيتلقون دعوات إلى مساحات العمل والمجموعات عبر البريد الإلكتروني عند توفيرهم بواسطة SCIM، يمكن لمالكي المؤسسات في الخطة المؤسسية القيام بما يلي:

1. افتح قائمة تبديل مساحة العمل وحدّد إدارة المؤسسة.

2. في علامة التبويب عام، فعِّل إيقاف رسائل البريد الإلكتروني الخاصة بالدعوات من توفير SCIM إذا كنت لا ترغب في إرسال رسائل بريد إلكتروني إلى المستخدمين.

لتوفير عضو مقيَّد من خلال SCIM، يجب عليك تعيين سمة "الدور" في 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 السمات التي ترسلها عبر واجهة برمجة تطبيقات SCIM الخاصة بـ Notion لتحسين تجربة توفير وإدارة المستخدمين والمجموعات.

• GET /Users

  • GET

  • استرداد قائمة بأعضاء مساحة العمل مقسمة إلى صفحات.

  • يمكنك تقسيم النتائج إلى صفحات باستخدام المعلمتين startIndex و count. لاحظ أن startIndex يبدأ من 1 وأن الحد الأقصى لـ count هو 100.

  • يمكنك تصفية النتائج باستخدام المعلمة filter. السمات الصالحة للتصفية هي email و given_name و family_name، على سبيل المثال GET

  • لاحظ أن given_name و family_name حساسان لحالة الأحرف. يتم تحويل البريد الإلكتروني إلى أحرف صغيرة.

• GET /Users/

  • GET

  • استرداد عضو معين في مساحة العمل بواسطة معرف مستخدم Notion الخاص به. سيكون هذا معرف UUID مكوناً من 32 حرفاً بالتنسيق التالي: 00000000-0000-0000-0000-000000000000.

  • لاحظ أن meta.created وmeta.lastModified لا تعكسان قيم طابع زمني ذات معنى.

• POST /Users

  • POST

  • إذا كان المستخدم الذي تضيفه يمتلك بالفعل حساب مستخدم Notion بنفس البريد الإلكتروني، فسيتم إضافته إلى مساحة العمل الخاصة بك.

  • إذا لم يكن المستخدم موجوداً، فإن استدعاء هذا يؤدي إلى إنشاء مستخدم Notion جديد ثم إضافته إلى مساحة عملك. وسيتم ربطه بملف تعريف مستخدم Notion الذي تم إنشاؤه.

  • ستقرأ واجهة برمجة تطبيقات SCIM خاصية صورة الملف الشخصي عند إنشاء المستخدم، ولكن ليس في التحديثات المستقبلية.

• PATCH /Users/

  • PATCH

  • يتم التحديث عبر سلسلة من العمليات، ويتم إرجاع سجل المستخدم المحدّث.

• PUT /Users/

  • PUT

  • يتم التحديث، ويتم إرجاع سجل المستخدم المحدّث.

• DELETE /Users/

  • DELETE

  • احذف مستخدمًا من مساحة عملك. يتم تسجيل خروج المستخدم من جميع الجلسات النشطة.

    • لا يمكن حذف حساب المستخدم من خلال SCIM. يجب إجراء حذف الحساب يدوياً.

    • يمكن أيضًا إزالة مستخدم من مساحة عملك عن طريق تعيين سمة المستخدم active إلى false بإرسال طلب PATCH /Users/ أو PUT /Users/.

    • لا يمكن إزالة مالك مساحة عمل الذي أنشأ رمز بوت SCIM عبر واجهة برمجة التطبيقات. عند إزالة مالك مساحة عمل عبر واجهة برمجة تطبيقات 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

  • حذف مجموعة مساحة عمل.