حذف سياسة OAuthV2Info

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info

الأدوات المستخدمة

تحذف هذه السياسة رمز تفويض 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">
السمة الوصف تلقائي التواجد في المنزل
async

اضبط هذه السمة على true لتحديد أنّه يجب تشغيل السياسة في مجموعة سلاسل محادثات مختلفة عن المجموعة التي تعالج مسار الطلب/الاستجابة. القيمة التلقائية هي false.

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

 خطأ اختياري
continueOnError

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

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

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

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

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

العنصر <AccessToken>

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
تلقائي: لا ينطبق
التواجد في المنزل: يجب توفّر <AccessToken> أو <AuthorizationCode>
النوع: سلسلة

السمات

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

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

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

العنصر <AuthorizationCode>

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

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
تلقائي: لا ينطبق
التواجد في المنزل: يجب توفّر <AccessToken> أو <AuthorizationCode>
النوع: سلسلة

السمات

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

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

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

العنصر<DisplayName>

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

<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). للرجوع إليها، تتوفر مخطّطات السياسات على GitHub.

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