إبطال سياسة OAuth V2

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

نظرة عامة

إبطال رموز الدخول عبر OAuth2 المرتبطة برقم تعريف تطبيق المطوِّر أو رقم تعريف المستخدم النهائي للتطبيق أو كليهما

يمكنك استخدام سياسة OAuthv2 لإنشاء رمز وصول OAuth 2.0. رمز مميّز أنشأه Apigee بالتنسيق التالي:

{
  "issued_at" : "1421847736581",
  "application_name" : "a68d01f8-b15c-4be3-b800-ceae8c456f5a",
  "scope" : "READ",
  "status" : "approved",
  "api_product_list" : "[PremiumWeatherAPI]",
  "expires_in" : "3599", //--in seconds
  "developer.email" : "tesla@weathersample.com",
  "organization_id" : "0",
  "token_type" : "BearerToken",
  "client_id" : "k3nJyFJIA3p62DWOkLO6OJNi87GYXFmP",
  "access_token" : "7S22UqXGJDTuUADGzJzjXzXSaGJL",
  "organization_name" : "myorg",
  "refresh_token_expires_in" : "0", //--in seconds
  "refresh_count" : "0"
}

يحتوي العنصر application_name على رقم تعريف تطبيق المطوِّر المرتبط بالرمز المميّز.

لا تتضمّن Apigee تلقائيًا رقم تعريف المستخدم النهائي في الرمز المميّز. يمكنك ضبط Apigee لتضمين معرِّف المستخدم النهائي من خلال إضافة عنصر <AppEndUser> إلى سياسة OAuthv2:

<OAuthV2 name="GenerateAccessTokenClient">
    <Operation>GenerateAccessTokenV/Operation>
    ...
    <AppEndUser>request.queryparam.app_enduser</AppEndUser>
</OAuthV2>

في هذا المثال، أدخِل رقم تعريف المستخدم النهائي إلى سياسة OAuthv2 في مَعلمة طلب بحث باسم app_enduser. يتم بعد ذلك تضمين رقم تعريف المستخدم النهائي في الرمز المميّز في عنصر app_enduser:

{
 "issued_at" : "1421847736581",
 "application_name" : "a68d01f8-b15c-4be3-b800-ceae8c456f5a",
 "scope" : "READ",
 "app_enduser" : "6ZG094fgnjNf02EK",
 "status" : "approved",
 "api_product_list" : "[PremiumWeatherAPI]",
 "expires_in" : "3599", //--in seconds
 "developer.email" : "tesla@weathersample.com",
 "organization_id" : "0",
 "token_type" : "BearerToken",
 "client_id" : "k3nJyFJIA3p62DWOkLO6OJNi87GYXFmP",
 "access_token" : "7S22UqXGJDTuUADGzJzjXzXSaGJL",
 "organization_name" : "myorg",
 "refresh_token_expires_in" : "0", //--in seconds
 "refresh_count" : "0"
}

إبطال حسب رقم تعريف تطبيق المطوّر

إبطال رموز الدخول عبر OAuth2 المرتبطة برقم تعريف تطبيق المطوِّر. تشتمل جميع رموز الدخول عبر OAuth2 التي تم إنشاؤها من خلال Apigee على رقم تعريف تطبيق المطوّر المرتبط. بالرمز المميز. ويمكنك بعد ذلك إبطال الرموز المميزة استنادًا إلى رقم تعريف التطبيق.

• يمكنك استخدام واجهة برمجة تطبيقات تطبيقات المطوّرين للحصول على قائمة بأرقام تعريف التطبيقات لمطوِّر معيَّن.

• يمكنك أيضًا استخدام واجهة برمجة تطبيقات تطبيقات المطوّرين للحصول على تفاصيل حول تطبيق.

الإلغاء حسب رقم تعريف المستخدم النهائي للتطبيق

يمكنك إبطال رموز الدخول عبر OAuth2 المرتبطة برقم تعريف مستخدم نهائي معيّن للتطبيق. هذا هو الرمز المميّز المرتبطة برقم تعريف المستخدم الذي تم إصدار الرموز المميزة له.

لا يوجد حقل لمعرّف المستخدم النهائي في رمز الدخول OAuth تلقائيًا. لتمكين إبطال رموز الدخول عبر OAuth 2.0 بواسطة معرّف المستخدم، يجب عليك تهيئة سياسة OAuthv2 لتضمين رقم تعريف المستخدم. في الرمز المميز، كما هو موضح أعلاه.

للحصول على معرّف مستخدم نهائي للتطبيق، استخدم واجهة برمجة تطبيقات تطبيقات المطوِّرين:

نماذج

تستخدم النماذج التالية سياسة "إبطال الإصدار 2 من OAuth" لإبطال رموز الدخول عبر OAuth2.

<RevokeOAuthV2 continueOnError="false" enabled="true" name="MyRevokeTokenPolicy">
  <DisplayName>Revoke OAuth v2.0-1</DisplayName>
  <AppId ref="request.queryparam.app_id"></AppId>
</RevokeOAuthV2>

<RevokeOAuthV2 continueOnError="false" enabled="true" name="MyRevokeTokenPolicy">
  <DisplayName>Revoke OAuth v2.0-1</DisplayName>
  <AppId ref="request.queryparam.app_id"></AppId>
  <RevokeBeforeTimestamp>1561939200000</RevokeBeforeTimestamp>
</RevokeOAuthV2>

مرجع العنصر

يصف مرجع العنصر عناصر وسمات السياسة DisputeOAuthV2.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RevokeOAuthV2 continueOnError="false" enabled="true" name="GetOAuthV2Info-1">
  <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
  <AppId ref="variable"></AppId>
  <EndUserId ref="variable"></EndUserId>
  <RevokeBeforeTimestamp ref="variable"></RevokeBeforeTimestamp>
  <Cascade>false</Cascade>
</RevokeOAuthV2>

<إلغاء OAuthV2> السمات

<RevokeOAuthV2 continueOnError="false" enabled="true" name="Revoke-OAuth-v20-1">

يصف الجدول التالي السمات المشتركة بين جميع العناصر الرئيسية للسياسة:

&lt;DisplayName&gt; عنصر

استخدِمه مع السمة name لتصنيف السياسة في إدارة خادم وكيل لواجهة المستخدم باسم مختلف بلغة طبيعية.

<DisplayName>Policy Display Name</DisplayName>

&lt;AppId&gt; عنصر

تُحدِّد رقم تعريف تطبيق المطوِّر للرموز المميّزة المطلوب إبطالها. نمرر إما متغير يحتوي على رقم تعريف تطبيق أو رقم تعريف تطبيق حرفي.

<AppId>appIdString</AppId>

or:

<AppId ref="request.queryparam.app_id"></AppId>

<Cascade> عنصر

إذا كان true ولديك رمز دخول تقليدي مبهم، حينئذٍ سيتم إبطال الرمز المميّز لإعادة التحميل ورمز الدخول إذا تم إدخال <AppId> أو مطابقة <EndUserId>. إذا كانت false، يتم إبطال رمز الدخول فقط وعدم تغيير الرمز المميز للتحديث. ينطبق السلوك نفسه لرموز الدخول المبهمة فقط.

<Cascade>false<Cascade>

&lt;EndUserId&gt; عنصر

تُحدِّد رقم تعريف المستخدم النهائي للتطبيق الخاص بالرمز المميّز المطلوب إبطاله. نمرر إما متغير يحتوي على رقم تعريف مستخدم أو سلسلة رمز مميز حرفي.

<EndUserId>userIdString</EndUserId>

or:

<EndUserId ref="request.queryparam.access_token"></EndUserId>

&lt;RevokeBeforeTimestamp&gt; عنصر

إبطال الرموز المميزة التي تم إصدارها قبل الطابع الزمني هذا العنصر متوافق مع <AppId>. و<EndUserId> للسماح لك بإبطال الرموز المميزة قبل وقت محدد. والقيمة التلقائية هي الوقت الذي يتم فيه تنفيذ السياسة.

<RevokeBeforeTimestamp>timeStampString</RevokeBeforeTimestamp>

or:

<RevokeBeforeTimestamp ref="request.queryparam.revoke_since_timestamp"></RevokeBeforeTimestamp>

متغيّرات التدفق

لا يتم ضبط سياسة إبطال OAuthV2 لمتغيّرات التدفق.

مرجع الخطأ

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

أخطاء بيئة التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة. أسماء الخطأ الموضحة أدناه هي السلاسل التي يتم تخصيصها للمتغيّر fault.name عند حدوث خطأ. مشاهدة الخطأ قسم "المتغيرات" أدناه لمزيد من التفاصيل.

أخطاء النشر

يمكنك الرجوع إلى الرسالة التي تم الإبلاغ عنها في واجهة المستخدم للحصول على معلومات عن أخطاء النشر.

متغيّرات الأخطاء

يتم ضبط هذه المتغيّرات عندما تؤدي هذه السياسة إلى ظهور خطأ في وقت التشغيل.

مثال على استجابة الخطأ

{
   "fault":{
      "faultstring":"Timestamp is in the future.",
      "detail":{
         "errorcode":"steps.oauth.v2.InvalidFutureTimestamp"
      }
   }
}

مثال على قاعدة الخطأ

<FaultRule name="RevokeOAuthV2 Faults">
    <Step>
        <Name>AM-InvalidTimestamp</Name>
    </Step>
    <Condition>(fault.name = "InvalidFutureTimestamp")</Condition>
</FaultRule>

مواضيع ذات صلة

• سياسة OAuthV2
• صفحة OAuth الرئيسية
• تخصيص الرموز المميّزة ورموز التفويض