DeleteOAuthV2Info

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

چه

کد صدور مجوز یا کد دسترسی OAuth V2 مشخص‌شده را حذف می‌کند.

نمونه‌ها

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

<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>

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

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

مشخصه‌ها

عنصر<DisplayName>

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

<DisplayName>DeleteOAuthV2Info 1</DisplayName>

خروجی

درصورت موفقیت، خط‌مشی وضعیت ۲۰۰ را برمی‌گرداند.

درصورت عدم موفقیت، خط‌مشی کد ۴۰۴ و بروندادی مشابه موارد زیر برمی‌گرداند (بسته به اینکه توکن دسترسی یا کد اصالت‌سنجی را حذف می‌کنید):

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 دردسترس است.

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

• خط‌مشی OAuthV2
• صفحه اصلی OAuth
• سفارشی‌سازی نشان‌ها و کدهای مجوز