ลบข้อมูล OAuthV2

คุณกำลังดูเอกสารประกอบของ 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

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

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

 false ไม่บังคับ
continueOnError

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

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

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

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

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

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

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

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

Attributes

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

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

 ไม่มี ไม่บังคับ

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

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

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

Attributes

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

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

 ไม่มี ไม่บังคับ

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

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

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
ค่าเริ่มต้น: ค่าของแอตทริบิวต์ name ของนโยบาย
การมีบุคคลอยู่: ไม่บังคับ
ประเภท: สตริง

เอาต์พุต

เมื่อสำเร็จ นโยบายจะแสดงสถานะ 200

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

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 สำหรับใช้อ้างอิง

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