Skip to main content
استخدم بيانات اعتماد عميل OAuth عندما يحتاج تكامل الواجهة الخلفية لديك إلى رموز وصول قصيرة العمر أو عندما تتطلب سياسة الأمان لديك ذلك. ينتمي كل عميل إلى حساب خدمة واحد ومؤسسة واحدة. OAuth اختياري: يكفي مفتاح API محدد النطاق لتكامل خادم خاص يمكنه تخزين المفتاح وتدويره بأمان. راجع المصادقة للاختيار بين الطريقتين وفهم كيفية ارتباط حسابات الخدمة بهما.
يجب تفعيل الوصول عبر OAuth لمؤسستك. يوفر الإعداد الخاص بك نقطة نهاية الرمز الإقليمية والجهة المصدِرة والجمهور المستهدف وطريقة مصادقة العميل. إذا كنت بحاجة إلى هذه الإعدادات أو لا يمكنك الوصول إلى إدارة العملاء، فاتصل بدعم Living Security.
يمثل منح بيانات اعتماد العميل حساب الخدمة الخاص بك. فهو لا يسجّل دخول شخص ولا يطلب من العميل تفويض تطبيق. التفويض المفوَّض عبر المتصفح هو إمكانية OAuth منفصلة ولا تتيحها هذه العمليات.

قبل البدء

  • أنشئ حساب خدمة بالأذونات التي يحتاج إليها التكامل فقط.
  • استخدم بيانات اعتماد إدارية مع service_account:manage وكل إذن تريد منحه للعميل الجديد. يجب أن يملك الحساب المستهدف هذه الأذونات أيضًا. لا يمكن للعميل توسيع صلاحيات أي من الحسابين.
  • اختر المنطقة الخاصة بالمؤسسة. يجب استخدام بيانات اعتماد API ورموز الوصول عبر OAuth على مضيف API الإقليمي المطابق.
  • احتفظ بسر العميل والرموز في مخزن الأسرار على جانب الخادم لديك. لا تضعها أبدًا في شيفرة المتصفح أو تطبيقات الجوال أو التحكم في المصدر أو سجلات الطلبات.

إنشاء عميل

يتطلب POST /v1/oauth_clients service_account_id، وقائمة غير فارغة من scopes الصريحة، وIdempotency-Key. لا تُقبل الأحرف البديلة. يدعم العميل ما يصل إلى 100 نطاق، بطول إجمالي لا يزيد على 4,096 حرفًا. يمكن أن يكون لكل حساب خدمة 20 عميلًا على الأكثر أو عمليات إنشاء/تنظيف غير محسومة. يؤدي الإبطال إلى رفض الوصول إلى API فورًا. ويستمر احتساب العميل أو عملية إنشاء غير مؤكدة لدى المزوّد ضمن الحد إلى أن يتم تأكيد التنظيف عن بُعد. ويمكن تحرير موضع الحجز المهجور أو عملية إنشاء ثبت فشلها قبل بدء عمل المزوّد بأمان. يظل مفتاح إعادة المحاولة الخاص بها مرتبطًا بالمحاولة الأصلية؛ لذا استرجع إيصالها قبل أن تقرر إنشاء بديل. اختر مفتاح إعادة محاولة واحدًا لمحاولة الإنشاء هذه واحفظه قبل إرسال الطلب. استخدم من 1 إلى 255 حرف ASCII مرئيًا، بدون مسافات. أعد استخدامه مع الحساب والنطاقات والجهة الإدارية والمنطقة وإصدار API نفسها بعد فقدان الاستجابة. لا يؤدي تدوير بيانات الاعتماد الإدارية ضمن حساب الخدمة نفسه إلى إنشاء هوية إعادة محاولة جديدة. ثبّت حزمة requests الخاصة بـ Python. حمّل قيم البيئة التالية عبر إدارة الأسرار والتكوين المعتادة لديك:
Python
ينفذ المثال طلبًا واحدًا ويحتفظ بالنتيجة في الذاكرة. أضف عملية الكتابة الخاصة بمدير الأسرار لديك عند النقطة المحددة قبل التشغيل في بيئة الإنتاج. وهو يتطلب عمدًا اتخاذ قرار بعد نتيجة غير مؤكدة بدلًا من إنشاء عميل آخر بصمت. كما تتطلب استثناءات الشبكة خطوات الاسترداد أدناه. تستخدم استجابات الإنشاء والإيصال 201 وتحتوي على مورد oauth_client مع id وservice_account_id وclient_id وscopes وstatus وcreated_at و client_secret. تُوسَم الاستجابات بـ Cache-Control: no-store.
  • id يحدد مورد المنصة. احفظه للاسترجاع والإبطال.
  • client_id يحدد العميل أثناء تبادل الرموز. وليس معرّف مورد المنصة. ويمكن أن يكون null أثناء انتظار الإنشاء.
  • client_secret يُعاد فقط للطلب الذي يُكمل الإنشاء. كل طلب إنشاء مكرر يعيد null، بما في ذلك إعادة المحاولة بعد فقدان استجابة النجاح. ولا يعيد الاسترجاع أي سر.

الاسترداد بعد فقدان الاستجابة أو انقطاعها

كرر طلب الإنشاء نفسه باستخدام مفتاح إعادة المحاولة المحفوظ لاسترجاع إيصال المورد. يعكس الإيصال الحالة الراهنة، لذا يبقى العميل المُبطَل مُبطَلًا. لا تستخدم هذه العملية عقد إعادة تشغيل الاستجابة المخزنة مؤقتًا العام لمدة 24 ساعة ولا تعيد ترويسة Idempotent-Replayed. راجع الأخطاء لمعرفة معرّفات الطلبات وتفاصيل الاسترداد. لا ترسل أبدًا سر العميل أو رمز الوصول مع طلب دعم.

الفحص والإبطال

استخدم بيانات الاعتماد الإدارية لديك وid الخاص بمورد المنصة: يحظر الإبطال طلبات API اللاحقة الخاصة بالعميل، بما في ذلك الطلبات التي تستخدم رموزًا صادرة مسبقًا. ولا يلغي العمل الذي قبله API بالفعل. قد يكتمل تنظيف بيانات الاعتماد عن بُعد لاحقًا. تكرار الإبطال آمن ولا يتطلب مفتاح إعادة محاولة. واصل استخدام بيانات الاعتماد الإدارية إذا كان العميل الذي يجري إبطاله هو نفسه مستدعي API.

التدوير دون فقدان الوصول

أنشئ عميلًا ثانيًا بالحد الأقصى المطلوب للنطاقات. احفظ سره، واحصل على رمز باستخدام نقطة نهاية الرمز الإقليمية، وتحقق من عمل التكامل به. حوّل التكامل إلى البديل، ثم أبطل المورد القديم. احتفظ ببيانات اعتماد إدارية مستقلة حتى تتمكن من التعافي من نشر غير سليم. لا يمكن لرموز الوصول منح أكثر من نطاقات العميل وأذونات حساب الخدمة الحالية. إن إزالة أذونات الحساب أو إبطال العميل لهما الأسبقية على ما تبقى من عمر الرمز. لا تعتبر الرمز المخزن مؤقتًا دليلًا على أن التفويض لا يزال صالحًا. احصل على رمز وصول جديد قبل انتهاء الصلاحية بمصادقة العميل مرة أخرى؛ فهذا المنح لا يستخدم رموز التحديث.