กําหนดนโยบาย OAuthV2Info

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X info

อะไร

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

คุณสามารถเพิ่มหรือแก้ไขแอตทริบิวต์ที่กำหนดเองได้เท่านั้น คุณไม่สามารถใช้นโยบายนี้เพื่อเปลี่ยนช่องต่างๆ เช่น ขอบเขต สถานะ expires_in, developer_email, client_id, org_name หรือ refresh_count หากแอตทริบิวต์มีอยู่แล้ว นโยบายนี้จะอัปเดตแอตทริบิวต์ดังกล่าว หากไม่มี นโยบายจะเพิ่มแอตทริบิวต์ โทเค็นเพื่อการเข้าถึงที่อ้างอิงต้องถูกต้องและอยู่ในสถานะที่ได้รับอนุมัติ

ตัวอย่าง

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

ข้อมูลอ้างอิงองค์ประกอบ

ข้อมูลอ้างอิงองค์ประกอบจะอธิบายองค์ประกอบและแอตทริบิวต์ของนโยบาย SetOAuthV2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

แอตทริบิวต์ <SetOAuthV2Info>

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

ตารางต่อไปนี้อธิบายแอตทริบิวต์ทั่วไปในองค์ประกอบระดับบนสุดของนโยบายทั้งหมด

&lt;DisplayName&gt; องค์ประกอบ

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

<DisplayName>Policy Display Name</DisplayName>

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

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

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

แอตทริบิวต์

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

ชุดแอตทริบิวต์ในโปรไฟล์โทเค็นเพื่อการเข้าถึงที่จะมีการแก้ไขหรือเพิ่ม

องค์ประกอบ <Attributes>/<Attribute>

แอตทริบิวต์แต่ละรายการที่จะอัปเดต

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

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

แอตทริบิวต์

ตัวแปรโฟลว์

เมื่อสำเร็จ ระบบจะตั้งค่าตัวแปรโฟลว์ต่อไปนี้

• oauthv2accesstoken.{policyName}.access_token
• oauthv2accesstoken.{policyName}.client_id
• oauthv2accesstoken.{policyName}.refresh_count
• oauthv2accesstoken.{policyName}.organization_name
• oauthv2accesstoken.{policyName}.expires_in //--in seconds
• oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
• oauthv2accesstoken.{policyName}.issued_at
• oauthv2accesstoken.{policyName}.status
• oauthv2accesstoken.{policyName}.api_product_list
• oauthv2accesstoken.{policyName}.token_type
• oauthv2accesstoken.{policyName}.{custom_attribute_name}

สคีมา

นโยบายแต่ละประเภทกำหนดโดยสคีมา XML (.xsd) คุณสามารถดูสคีมานโยบาย ได้ใน GitHub

ข้อมูลอ้างอิงข้อผิดพลาด

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

ข้อผิดพลาดเกี่ยวกับรันไทม์

ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นเมื่อมีการดำเนินการตามนโยบาย

ข้อผิดพลาดในการติดตั้งใช้งาน

โปรดดูข้อมูลเกี่ยวกับข้อผิดพลาดในการติดตั้งใช้งานในข้อความที่รายงานใน UI

ตัวแปรข้อผิดพลาด

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

ตัวอย่างการตอบกลับข้อผิดพลาด

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

ตัวอย่างกฎข้อบกพร่อง

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

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

• นโยบาย OAuthV2
• หน้าแรกของ OAuth
• การปรับแต่งโทเค็น และรหัสการให้สิทธิ์