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

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

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

 false اختياري
continueOnError

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

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

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

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

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

عنصر <AccessToken>

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

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

السمات

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

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

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

العنصر <تفويضCode>

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

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

السمات

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

متغير رمز الدخول. وعادةً ما يتم استردادها من متغير تدفق. على سبيل المثال: 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.

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