รับนโยบาย OAuthV2Info

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

อะไร

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

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

โทเค็นเพื่อการเข้าถึงที่คุณส่งไปยังนโยบายนี้ต้องใช้งานได้ มิฉะนั้นนโยบายจะส่ง ข้อผิดพลาด invalid_access_token รายการ

ตัวอย่าง

ตัวอย่างต่อไปนี้ใช้นโยบายรับข้อมูล OAuth V2 เพื่อเรียกข้อมูลเกี่ยวกับ ของเวิร์กโฟลว์ OAuth2 แล้วจึงเข้าถึงข้อมูลนั้นภายในโค้ด

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

การอ้างอิงองค์ประกอบ

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

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

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

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

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

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

<DisplayName>Policy Display Name</DisplayName>

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

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

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

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

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

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

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

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

<ClientId ref="request.queryparam.client_id"></ClientId>

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

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

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

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

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

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

ตัวแปรโฟลว์

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

ตัวแปรรหัสไคลเอ็นต์

ระบบจะเติมค่าตัวแปรเหล่านี้เมื่อมีการตั้งค่าองค์ประกอบ ClientId

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

ตัวแปรโทเค็นเพื่อการเข้าถึง

จะมีการเติมค่าตัวแปรเหล่านี้เมื่อมีการตั้งค่าองค์ประกอบ AccessToken

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

ตัวแปรรหัสการให้สิทธิ์

ระบบจะเติมค่าตัวแปรเหล่านี้เมื่อมีการตั้งค่าองค์ประกอบ AuthorizationCode

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

รีเฟรชตัวแปรโทเค็น

จะมีการเติมค่าตัวแปรเหล่านี้เมื่อมีการตั้งค่าองค์ประกอบ RefreshToken

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

สคีมา

นโยบายแต่ละประเภทจะกำหนดโดยสคีมา XML (.xsd) สคีมานโยบายสำหรับใช้อ้างอิง ที่มีอยู่ใน GitHub

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

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Example fault rule

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

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

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