خط‌مشی 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، اجرای «جریان» درصورت عدم موفقیت ادامه می‌یابد.

نادرست اختیاری
فعال شد تعیین می‌کند که آیا خط‌مشی اجرا می‌شود یا نه. اگر روی 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.

موجود نیست اختیاری

عنصر <AuthorizationCode>

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

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

مشخصه‌ها

مشخصه شرح پیش‌فرض حضور
مرجع

متغیر کد دسترسی. معمولاً از متغیر جاری‌سازی بازیابی می‌شود. برای مثال: request.header.code یا request.queryparam.code.

موجود نیست اختیاری

عنصر<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» را ببینید.

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

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

متغیرهای خطا

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

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

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