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

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

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

 خطأ اختياري
continueOnError

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

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

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

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

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

السمات

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

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

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

عنصر <DisplayName>

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

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

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