authentication.
تُرسل كل استدعاءات API الواردة أدناه إلى واجهة إدارة Authentication الخاصة بتطبيقك. عنوان MANAGEMENT_BASE هو:
openapi-authentication.json المسارات نفسها ضمن الوسم Setup، وتعتمد عليه حزم SDK للخوادم في توليد نسخها.
أي بيانات اعتماد تستخدم
يعمل أيٌّ من بيانات الاعتماد الثلاثة، وتقتصر كل منها على ما وافق عليه مالكها.
تُرفض بيانات الاعتماد هذه برمز الحالة
403 في كل مسار من مسارات الإعداد، بغض النظر عما يطلبه الطلب من إجراء:
- السر الأساسي للتطبيق.
- token من
POST /programmatic/login، ويُصدر للتطبيق لا للوحة التحكم. - مفتاح بدون نطاق
authentication، بما في ذلك المفتاح الذي أُنشئ بأعلى مستوى لكل مورد: هذه المفاتيح تظهر بوصفها وصولاً كاملاً، وتبقى الحقولscopesفارغة، ولا تُقبل في هذه المسارات. - مفتاح يتبع تطبيقاً آخر، وتفويض مقتصر على
didit:verification، وتفويض معتمد لمؤسسة أخرى.
401. ويبقى لكل تفويض أو مفتاح حدوده الخاصة فوق ذلك: التفويض يحتفظ بنطاقاته والمؤسسات ودور الشخص، والمفتاح يحتفظ بنطاقاته وقائمة السماح لعناوين IP وتاريخ انتهاء صلاحيته.
الموافقة على الوصول
باستخدام مفتاح API مُسمّى
افتح Developers -> API keys في Business Console وأنشئ مفتاحًا للتطبيق الذي تقوم بإعداده. امنحه موردauthentication بصلاحية read أو write: تغطي صلاحية read كل استدعاء يقرأ الإعداد (GET)، وتغطي صلاحية write كل استدعاء يغيّر الإعداد (POST وPUT وPATCH وDELETE) ويقرؤه أيضًا. راجع مفاتيح API للاطلاع على انتهاء الصلاحية وقوائم السماح لعناوين IP وتدوير المفاتيح؛ يتبع المفتاح تطبيقًا واحدًا ولا يعمل إلا معه.
عبر اتصال MCP
يستخدم الوكيل المتصل بخادم Didit MCP الإذنَ الذي وافق عليه مالكه في شاشة الموافقة، معdidit:management. راجع مصادقة MCP.
لمالك بدون كلمة مرور
تتيح منحة رمز الجهاز (RFC 8628) لمالكٍ يسجّل الدخول عبر Google أو مفتاح المرور أو رمز يُرسل إلى بريده الإلكتروني أن يوافق على الوصول نفسه من أي متصفح، دون كتابة كلمة مرور. راجع تسجيل الدخول بدون متصفح.تفعيل رمز البريد الإلكتروني
يقبلPUT methods/{name}/ الحقل enabled فقط، ولا شيء غيره بالنسبة إلى طريقة لا تتطلب بيانات اعتماد.
credential_source: null. أما الطرق المفعّلة دائمًا فلا يمكن إيقافها، إذ يرد هذا الطلب بـ {"enabled": "always_on"}.
تفعيل Google
تأخذ طريقة المصادقة الاجتماعية بيانات اعتماد تطبيق OAuth الخاص بك، أو تطبيق الاختبار من Didit في تطبيق في البيئة التجريبية.باستخدام تطبيق Google الخاص بك
callback_uri الذي تعيده الاستجابة لدى مزود الخدمة. السر للكتابة فقط: لا تعيده أي استجابة، ولا يمكن استرجاع سوى client_id. إذا فعّلت طريقة دون بيانات اعتماد، وكانت لا تملك أي بيانات محفوظة من قبل، فستجيب بـ {"credentials": "required"}.
باستخدام تطبيق الاختبار من Didit (didit_test)
يمكن لتطبيق في البيئة التجريبية أن يستخدم تطبيقات Didit الاجتماعية بدلًا من تطبيقاتك، وهذا يكفي لإكمال الإعداد والتحقق من أنه يعمل:
didit_test مزودي Google وMicrosoft وApple وGitHub، في التطبيقات التجريبية فقط:
يُسمّي طلب
GET على الإعدادات المزودين الذين يمكن لتطبيق الاختبار خدمتهم لهذا التطبيق في didit_test_credentials، وتكون قيمته false لجميع المزودين الأربعة في تطبيق في بيئة الإنتاج.
قراءة الإعداد
GET على MANAGEMENT_BASE هو طلب القراءة للإعداد: كل طريقة مع enabled وcredential_source، إضافةً إلى روابط الاستدعاء وقواعد الجلسة وسياسة التسجيل.
GET واحد لمعرفة ما هو مفعّل وما هو غير مفعّل. تكون قيمة enabled في أعلى الاستجابة false عندما تكون المصادقة معطّلة للتطبيق. أي تغيير في الإعداد يُجرى بمنحة إدارة أو بمفتاح مسمّى يُرجع الخطأ 409 مع {"detail": "product_disabled"}، ولا يُحفظ أي شيء. لا يُفعّل أي استدعاء للإعداد المصادقة، إذ يقوم شخص بتفعيلها للتطبيق من وحدة التحكم، وتعمل استدعاءاتك بعد ذلك.
باقي الإعداد
يتيح التفويض أو المفتاح الوصول إلى الإعداد وعدّاداته فقط، ولا يتيح أبداً الوصول إلى بيانات المستخدم النهائي: المسارات
users/ وsessions/ وsign-ins/ وoverview/، والمؤسسات العميلة، والأدوار، والاستيراد، وجلسات الوكلاء، ورسائل البريد الإلكتروني التجريبية ما زالت تتطلب جلسة في وحدة التحكم.
ينطبق الإعداد agent_humans_only على التطبيق بأكمله. لا يمكن تغييره إلا من مالك المؤسسة أو مسؤولها. يتلقى المفتاح المسمّى الاستجابة 403 owner_or_admin_required. يتطلب تفعيل الإعداد أيضاً وجود مفتاح مرور مسجَّل (passkey_required).