أنت تعرض مستندات 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">
السمة | الوصف | تلقائي | التواجد في المنزل |
---|---|---|---|
غير متزامن |
يجب ضبط القيمة على " يُستخدَم هذا الإعداد للتحسين الداخلي فقط. |
خطأ | اختياري |
continueOnError |
من المتوقّع أن تعرض معظم السياسات رسالة خطأ عند حدوث تعذُّر. من خلال تعيين هذه
إلى |
خطأ | اختياري |
مفعّلة | تحدِّد هذه السياسة ما إذا كانت السياسة سارية أم لا. في حال ضبط السياسة على false ، سيتم
يتم "إيقاف" السياسة، ولم يتم فرضها (على الرغم من بقاء السياسة مرتبطة
التدفق). |
صحيح | اختياري |
الاسم |
الاسم الداخلي للسياسة. تتم الإشارة إلى هذا الاسم في عناصر الخطوة لإرفاقها السياسة إلى التدفق. ملاحظة: تقتصر الأحرف التي يمكنك استخدامها في الاسم على:
|
لا ينطبق | مطلوب |
<AccessToken> عنصر
تحدد المتغير الذي يوجد فيه رمز الدخول المراد حذفه. على سبيل المثال، إذا كانت قيمة
يتم إرفاق رمز الدخول للطلب باعتبارها معلمة طلب بحث تسمى "access_token"، حدد
request.queryparam.access_token
يمكنك استخدام أي متغير صالح يشير إلى
الرمز المميز. أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
الإعداد التلقائي: | لا ينطبق |
الحضور: | قيمة <AccessToken> أو <AuthorizationCode> هي
مطلوبة. |
النوع: | سلسلة |
السمات
السمة | الوصف | تلقائي | التواجد في المنزل |
---|---|---|---|
المرجع |
متغيّر رمز الدخول يتم استردادها عادةً من متغير التدفق. بالنسبة
مثال: |
لا ينطبق | اختياري |
<AuthorizationCode> عنصر
يحدّد المتغيّر الذي يقع فيه رمز التفويض المطلوب حذفه. على سبيل المثال، إذا كانت قيمة
يتم إرفاق كود المصادقة للطلب كمعلمة طلب بحث تسمى "code"، حدد
request.queryparam.code
يمكنك استخدام أي متغيّر صالح يشير إلى الرمز المميّز.
أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
الإعداد التلقائي: | لا ينطبق |
الحضور: | قيمة <AccessToken> أو <AuthorizationCode> هي
مطلوبة. |
النوع: | سلسلة |
السمات
السمة | الوصف | تلقائي | التواجد في المنزل |
---|---|---|---|
المرجع |
متغيّر رمز الدخول يتم استردادها عادةً من متغيّر التدفق. بالنسبة
مثال: |
لا ينطبق | اختياري |
<DisplayName> عنصر
اسم لغة طبيعية يصنِّف السياسة في محرِّر الخادم الوكيل لواجهة مستخدم الإدارة. إذا تم حذفها، استخدام سمة اسم السياسة.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
الإعداد التلقائي: | تمثّل هذه السمة قيمة السمة name للسياسة. |
الحضور: | اختياري |
النوع: | سلسلة |
مرجع الخطأ
This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.
Runtime errors
These errors can occur when the policy executes.
Fault code | HTTP status | Cause |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 | The access token sent to the policy is invalid. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 | The authorization code sent to the policy is invalid. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 | Please see this Apigee Community post for information about troubleshooting this error. |
Deployment errors
Refer to the message reported in the UI for information about deployment errors.
Fault variables
These variables are set when this policy triggers an error at runtime.
Variables | Where | Example |
---|---|---|
fault.name="fault_name" |
fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. | fault.name = "invalid_access_token" |
oauthV2.policy_name.failed |
policy_name is the user-specified name of the policy that threw the fault. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name is the user-specified name of the policy that threw the fault. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name is the user-specified name of the policy that threw the fault. | oauthV2.DeleteTokenInfo.cause = Invalid Access Token |
Example error response
{ "fault": { "faultstring": "Invalid Access Token", "detail": { "errorcode": "keymanagement.service.invalid_access_token" } } }
Example fault rule
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults"> <Step> <Name>AM-InvalidTokenResponse</Name> </Step> <Condition>(fault.name = "invalid_access_token")</Condition> </FaultRule>
المخطط
يتم تحديد كل نوع سياسة من خلال مخطّط XML (.xsd
). يمكنك الرجوع إلى مخططات السياسات
المتوفرة على جيت هب.