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