خط مشی DeleteOAuthV2Info

شما در حال مشاهده اسناد 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 ، اجرای Flow در صورت شکست ادامه می یابد.

 نادرست اختیاری
فعال شد تعیین می کند که آیا یک سیاست اجرا می شود یا خیر. اگر روی false تنظیم شود، یک خط‌مشی «خاموش» می‌شود و اجرا نمی‌شود (حتی اگر این خط‌مشی به یک جریان متصل می‌ماند). درست است اختیاری
نام

نام داخلی سیاست. این نام در عناصر Step برای پیوست کردن خط مشی به یک جریان ارجاع شده است.

توجه: نویسه هایی که می توانید در نام استفاده کنید محدود به: A-Z0-9._\-$ % . رابط کاربری مدیریت محدودیت‌های اضافی را اعمال می‌کند، مانند حذف خودکار نویسه‌هایی که حروف عددی نیستند.

 N/A مورد نیاز

عنصر <AccessToken>

متغیری را مشخص می کند که نشانه دسترسی برای حذف در آن قرار دارد. به عنوان مثال، اگر نشانه دسترسی به پیام درخواست به عنوان یک پارامتر پرس و جو به نام "access_token" پیوست شده است، request.queryparam.access_token را مشخص کنید. می توانید از هر متغیر معتبری که به نشانه اشاره می کند استفاده کنید. یا، می تواند در رشته رمز به معنای واقعی کلمه عبور کند (مورد نادر). 

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
پیش فرض: N/A
حضور: یا <AccessToken> یا <AuthorizationCode> مورد نیاز است.
نوع: رشته

صفات

صفت توضیحات پیش فرض حضور
رجوع کنید

یک متغیر نشانه دسترسی. به طور معمول، از یک متغیر جریان بازیابی می شود. به عنوان مثال: request.header.token یا request.queryparam.token .

 N/A اختیاری

عنصر <AuthorizationCode>

متغیری را که کد مجوز حذف در آن قرار دارد را مشخص می کند. برای مثال، اگر کد auth به پیام درخواست به عنوان یک پارامتر پرس و جو به نام "code" پیوست شده است، request.queryparam.code را مشخص کنید. می توانید از هر متغیر معتبری که به نشانه اشاره می کند استفاده کنید. یا، می تواند در رشته رمز به معنای واقعی کلمه عبور کند (مورد نادر). 

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
پیش فرض: N/A
حضور: یا <AccessToken> یا <AuthorizationCode> مورد نیاز است.
نوع: رشته

صفات

صفت توضیحات پیش فرض حضور
رجوع کنید

یک متغیر نشانه دسترسی. به طور معمول، از یک متغیر جریان بازیابی می شود. به عنوان مثال: request.header.code یا request.queryparam.code .

 N/A اختیاری

عنصر <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 را برای اطلاعات در مورد عیب یابی این خطا ببینید.

خطاهای استقرار

برای اطلاعات در مورد خطاهای استقرار به پیام گزارش شده در UI مراجعه کنید.

متغیرهای خطا

این متغیرها زمانی تنظیم می شوند که این خط مشی خطایی را در زمان اجرا ایجاد کند.

متغیرها کجا مثال
fault.name=" fault_name " fault_name نام خطا است، همانطور که در جدول خطاهای Runtime در بالا ذکر شده است. نام خطا آخرین قسمت کد خطا است. 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 در دسترس هستند.

موضوعات مرتبط