คุณกำลังดูเอกสารประกอบ 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">
แอตทริบิวต์ | คำอธิบาย | ค่าเริ่มต้น | การมีบุคคลอยู่ |
---|---|---|---|
ไม่พร้อมกัน |
ตั้งค่าเป็น การตั้งค่านี้จะใช้สำหรับการเพิ่มประสิทธิภาพภายในเท่านั้น |
เท็จ | ไม่บังคับ |
continueOnError |
นโยบายส่วนใหญ่มักแสดงผลข้อผิดพลาดเมื่อเกิดความล้มเหลว โดยการตั้งค่านี้
เป็น |
เท็จ | ไม่บังคับ |
เปิดใช้อยู่ | กำหนดว่าจะบังคับใช้นโยบายหรือไม่ หากตั้งค่าเป็น false ค่า
"ปิดใช้" นโยบาย และไม่ได้บังคับใช้ (แม้ว่าจะยังคงแนบนโยบายกับ
โฟลว์) |
จริง | ไม่บังคับ |
ชื่อ |
ชื่อภายในของนโยบาย ระบบจะอ้างอิงชื่อนี้ในองค์ประกอบขั้นตอนที่จะแนบ นโยบายไปยังโฟลว์ หมายเหตุ: อักขระที่คุณใช้ในชื่อได้ถูกจำกัดไว้เฉพาะสิ่งต่อไปนี้
|
ไม่มี | ต้องระบุ |
<AccessToken> องค์ประกอบ
ระบุตัวแปรที่มีโทเค็นเพื่อการเข้าถึงที่ต้องการลบ ตัวอย่างเช่น หาก
โทเค็นเพื่อการเข้าถึงจะแนบไปกับข้อความคำขอ เป็นพารามิเตอร์การค้นหาชื่อ "access_token" โปรดระบุ
request.queryparam.access_token
คุณสามารถใช้ตัวแปรใดก็ได้ที่ถูกต้องที่อ้างอิงพารามิเตอร์
โทเค็น หรือส่งในสตริงโทเค็นตามตัวอักษรได้ (กรณีไม่บ่อยนัก)
<AccessToken ref="request.queryparam.access_token"></AccessToken>
ค่าเริ่มต้น: | ไม่มี |
การตรวจหาบุคคล: | <AccessToken> หรือ <AuthorizationCode> อาจเป็น
ต้องระบุ |
ประเภท: | สตริง |
Attributes
แอตทริบิวต์ | คำอธิบาย | ค่าเริ่มต้น | การมีบุคคลอยู่ |
---|---|---|---|
อ้างอิง |
ตัวแปรโทเค็นเพื่อการเข้าถึง โดยทั่วไปจะดึงมาจากตัวแปรโฟลว์ สำหรับ
ตัวอย่าง: |
ไม่มี | ไม่บังคับ |
<AuthorizationCode> องค์ประกอบ
ระบุตัวแปรที่เป็นตำแหน่งของรหัสการให้สิทธิ์ที่จะลบ ตัวอย่างเช่น หาก
auth code ถูกแนบไปกับข้อความคำขอ เป็นพารามิเตอร์การค้นหาที่เรียกว่า "code" โปรดระบุ
request.queryparam.code
คุณสามารถใช้ตัวแปรที่ถูกต้องใดก็ได้ที่อ้างอิงโทเค็น
หรือส่งในสตริงโทเค็นตามตัวอักษรได้ (กรณีไม่บ่อยนัก)
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
ค่าเริ่มต้น: | ไม่มี |
การตรวจหาบุคคล: | <AccessToken> หรือ <AuthorizationCode> อาจเป็น
ต้องระบุ |
ประเภท: | สตริง |
Attributes
แอตทริบิวต์ | คำอธิบาย | ค่าเริ่มต้น | การมีบุคคลอยู่ |
---|---|---|---|
อ้างอิง |
ตัวแปรโทเค็นเพื่อการเข้าถึง โดยทั่วไปจะดึงมาจากตัวแปรโฟลว์ สำหรับ
ตัวอย่าง: |
ไม่มี | ไม่บังคับ |
<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