حذف 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 يمكنك استخدام أي متغيّر صالح يشير إلى الرمز المميّز. أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).

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

السمات

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

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

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

&lt;DisplayName&gt; عنصر

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

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

الناتج

عند نجاح السياسة، تعرض السياسة الحالة 200.

وفي حال تعذُّر ذلك، تعرض السياسة الخطأ 404 ومخرجات مشابهة لما يلي (اعتمادًا على ما إذا كان أنت تحذف رمز الدخول أو رمز المصادقة):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

المخطط

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

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