ลบนโยบาย OAuthV2Info

คุณกำลังดูเอกสารประกอบของ 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">
แอตทริบิวต์ คำอธิบาย ค่าเริ่มต้น การมีบุคคลอยู่
async

ตั้งค่าเป็น true เพื่อระบุว่านโยบายควรเรียกใช้ในพูลเทรด ต่างจากพูลที่ให้บริการโฟลว์คำขอ/คำตอบ ค่าเริ่มต้นคือ false

การตั้งค่านี้ใช้สำหรับการเพิ่มประสิทธิภาพภายในเท่านั้น

 false ไม่บังคับ
continueOnError

นโยบายส่วนใหญ่จะแสดงข้อผิดพลาดเมื่อเกิดข้อผิดพลาด เมื่อตั้งค่าแอตทริบิวต์นี้เป็น true การดำเนินการโฟลว์จะดำเนินต่อไปเมื่อล้มเหลว

 false ไม่บังคับ
เปิดใช้อยู่ ตรวจสอบว่ามีการบังคับใช้นโยบายหรือไม่ หากตั้งค่าเป็น false ระบบจะ "ปิด" นโยบายและจะไม่บังคับใช้ (แม้ว่านโยบายจะยังคงแนบอยู่กับโฟลว์ก็ตาม) จริง ไม่บังคับ
ชื่อ

ชื่อภายในของนโยบาย มีการอ้างอิงชื่อนี้ในองค์ประกอบขั้นตอนเพื่อแนบนโยบายกับโฟลว์

หมายเหตุ: อักขระที่คุณใช้ในชื่อได้ต้องมีลักษณะดังนี้ A-Z0-9._\-$ % UI การจัดการจะบังคับใช้ข้อจํากัดเพิ่มเติม เช่น นําอักขระที่ไม่ใช่ตัวอักษรและตัวเลขคละกันออกโดยอัตโนมัติ

 ไม่มีข้อมูล ต้องระบุ

องค์ประกอบ <AccessToken>

ระบุตัวแปรที่มีโทเค็นเพื่อการเข้าถึงที่ต้องการลบ ตัวอย่างเช่น หากมีการแนบโทเค็นเพื่อการเข้าถึงกับข้อความคำขอเป็นพารามิเตอร์การค้นหาชื่อ "access_token" ให้ระบุ request.queryparam.access_token คุณจะใช้ตัวแปรใดก็ได้ที่ถูกต้องซึ่งอ้างอิงโทเค็นนี้ หรือสามารถส่งผ่านสตริงโทเค็นลิเทอรัล (ไม่ใช่กรณีทั่วไป)

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
ค่าเริ่มต้น: ไม่มีข้อมูล
สถานที่ตั้ง: ต้องระบุ <AccessToken> หรือ <AuthorizationCode>
ประเภท: สตริง

Attributes

แอตทริบิวต์ คำอธิบาย ค่าเริ่มต้น การมีบุคคลอยู่
อ้างอิง

ตัวแปรโทเค็นเพื่อการเข้าถึง โดยปกติจะดึงมาจากตัวแปรโฟลว์ เช่น request.header.token หรือ request.queryparam.token

 ไม่มีข้อมูล ไม่บังคับ

องค์ประกอบ <AuthorizationCode>

ระบุตัวแปรที่มีรหัสการให้สิทธิ์ที่จะลบ เช่น หากมีการแนบรหัสการให้สิทธิ์กับข้อความคำขอเป็นพารามิเตอร์การค้นหาชื่อ "code" ให้ระบุ request.queryparam.code คุณจะใช้ตัวแปรใดก็ได้ที่ถูกต้องซึ่งอ้างอิงโทเค็นนี้ หรือสามารถส่งผ่านสตริงโทเค็นลิเทอรัล (ไม่ใช่กรณีทั่วไป)

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
ค่าเริ่มต้น: ไม่มีข้อมูล
สถานที่ตั้ง: ต้องระบุ <AccessToken> หรือ <AuthorizationCode>
ประเภท: สตริง

Attributes

แอตทริบิวต์ คำอธิบาย ค่าเริ่มต้น การมีบุคคลอยู่
อ้างอิง

ตัวแปรโทเค็นเพื่อการเข้าถึง โดยปกติจะดึงมาจากตัวแปรโฟลว์ เช่น request.header.code หรือ request.queryparam.code

 ไม่มีข้อมูล ไม่บังคับ

เอลิเมนต์ <DisplayName>

ชื่อที่เป็นภาษาธรรมชาติที่มีป้ายกำกับนโยบายในเครื่องมือแก้ไขพร็อกซี UI การจัดการ หากละไว้ ระบบจะใช้แอตทริบิวต์ชื่อนโยบาย

<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 คือชื่อของข้อผิดพลาดตามที่แสดงในตารางข้อผิดพลาดรันไทม์ด้านบน ชื่อข้อผิดพลาดคือส่วนสุดท้ายของโค้ดข้อผิดพลาด 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

หัวข้อที่เกี่ยวข้อง