حذف سياسة OAuthV2Info

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

المزايا

يؤدي هذا الإجراء إلى حذف رمز تفويض OAuth V2 المحدّد أو رمز الدخول.

نماذج

حذف رمز الدخول

في ما يلي مثال على سياسة تُستخدَم لحذف رمز الدخول OAuth 2.0. يحدد المثال أدناه رمز الدخول المراد حذفه في رسالة الطلب من خلال البحث عن عنوان يسمى access_token

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

حذف رمز المصادقة

في ما يلي مثال على سياسة تُستخدَم لحذف رمز تفويض OAuth 2.0. المثال أدناه لتحديد موقع رمز المصادقة لحذفه في رسالة الطلب من خلال البحث عن معلَمة طلب بحث تسمى code

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

مرجع العنصر

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1">    
    <DisplayName>Delete OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>-->
    <Attributes/>
</DeleteOAuthV2Info

<DeleteOAuthV2Info> السمات

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
السمة الوصف تلقائي التواجد في المنزل
غير متزامن

يجب ضبط القيمة على "true" لتحديد تنفيذ السياسة في سلسلة محادثات. مختلفة عن المجموعة التي تخدم تدفق الطلب/الاستجابة. الإعداد التلقائي false.

يُستخدَم هذا الإعداد للتحسين الداخلي فقط.

 خطأ اختياري
continueOnError

من المتوقّع أن تعرض معظم السياسات رسالة خطأ عند حدوث تعذُّر. من خلال تعيين هذه إلى true، سيستمر تنفيذ التدفق عند التعذُّر.

 خطأ اختياري
مفعّلة تحدِّد هذه السياسة ما إذا كانت السياسة سارية أم لا. في حال ضبط السياسة على false، سيتم يتم "إيقاف" السياسة، ولم يتم فرضها (على الرغم من بقاء السياسة مرتبطة التدفق). صحيح اختياري
الاسم

الاسم الداخلي للسياسة. تتم الإشارة إلى هذا الاسم في عناصر الخطوة لإرفاقها السياسة إلى التدفق.

ملاحظة: تقتصر الأحرف التي يمكنك استخدامها في الاسم على: A-Z0-9._\-$ % تفرض واجهة مستخدم الإدارة قيودًا إضافية، مثل إزالة الأحرف غير الأبجدية الرقمية تلقائيًا.

 لا ينطبق مطلوب

&lt;AccessToken&gt; عنصر

تحدد المتغير الذي يوجد فيه رمز الدخول المراد حذفه. على سبيل المثال، إذا كانت قيمة يتم إرفاق رمز الدخول للطلب باعتبارها معلمة طلب بحث تسمى "access_token"، حدد request.queryparam.access_token يمكنك استخدام أي متغير صالح يشير إلى الرمز المميز. أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
الإعداد التلقائي: لا ينطبق
الحضور: قيمة <AccessToken> أو <AuthorizationCode> هي مطلوبة.
النوع: سلسلة

السمات

السمة الوصف تلقائي التواجد في المنزل
المرجع

متغيّر رمز الدخول يتم استردادها عادةً من متغيّر التدفق. بالنسبة مثال: request.header.token أو request.queryparam.token

 لا ينطبق اختياري

&lt;AuthorizationCode&gt; عنصر

يحدّد المتغيّر الذي يقع فيه رمز التفويض المطلوب حذفه. على سبيل المثال، إذا كانت قيمة يتم إرفاق كود المصادقة للطلب كمعلمة طلب بحث تسمى "code"، حدد request.queryparam.code يمكنك استخدام أي متغيّر صالح يشير إلى الرمز المميّز. أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
الإعداد التلقائي: لا ينطبق
الحضور: قيمة <AccessToken> أو <AuthorizationCode> هي مطلوبة.
النوع: سلسلة

السمات

السمة الوصف تلقائي التواجد في المنزل
المرجع

متغيّر رمز الدخول يتم استردادها عادةً من متغيّر التدفق. بالنسبة مثال: request.header.code أو request.queryparam.code

 لا ينطبق اختياري

&lt;DisplayName&gt; عنصر

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

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
الإعداد التلقائي: تمثّل هذه السمة قيمة السمة name للسياسة.
الحضور: اختياري
النوع: سلسلة

مرجع الخطأ

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

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

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة.

رمز الخطأ رموز حالة HTTP السبب
steps.oauth.v2.invalid_access_token 401 رمز الدخول الذي تم إرساله إلى السياسة غير صالح.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 رمز التفويض الذي تم إرساله إلى السياسة غير صالح.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 يُرجى مراجعة هذه المشاركة في منتدى Apigee للحصول على معلومات حول تحديد هذا الخطأ وحلّها.

أخطاء النشر

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

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

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

المتغيرات المكان مثال
fault.name="fault_name" fault_name هو اسم الخطأ، كما هو موضَّح في جدول أخطاء وقت التشغيل أعلاه. اسم الخطأ هو الجزء الأخير من رمز الخطأ. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name هو الاسم الذي يحدّده المستخدم للسياسة التي أدّت إلى حدوث الخطأ. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name هو الاسم الذي يحدّده المستخدم للسياسة التي أدّت إلى حدوث الخطأ. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name هو الاسم الذي يحدّده المستخدم للسياسة التي أدّت إلى حدوث الخطأ. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

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

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

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

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

المخطط

يتم تحديد كل نوع سياسة من خلال مخطّط XML (.xsd). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

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