خط مشی 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">

عنصر <AccessToken>

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>

صفات

عنصر <AuthorizationCode>

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

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>

صفات

عنصر <DisplayName>

نامی به زبان طبیعی که خط‌مشی را در ویرایشگر پروکسی رابط کاربری مدیریت برچسب‌گذاری می‌کند. در صورت حذف، از ویژگی نام سیاست استفاده می شود.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>

مرجع خطا

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.

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.

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 ) تعریف می شود. برای مرجع، طرح‌های خط‌مشی در GitHub در دسترس هستند.

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

• خط مشی OAuthV2
• خانه OAuth
• سفارشی کردن توکن ها و کدهای مجوز