Kebijakan SetOAuthV2Info

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Apa

Memungkinkan Anda menambahkan atau memperbarui atribut khusus yang terkait dengan token akses. Atribut khusus mungkin menyertakan hal-hal seperti nama departemen, ID pelanggan, atau pengenal sesi. Lihat juga Menyesuaikan Token dan Kode Otorisasi.

Anda hanya dapat menambahkan atau mengubah atribut khusus. Anda tidak dapat menggunakan kebijakan ini untuk mengubah {i>field<i} seperti scope, status, expiry_in, developer_email, client_id, org_name, atau refresh_count. Jika sudah ada, kebijakan ini akan memperbaruinya. Jika tidak ada, kebijakan akan menambahkannya. Tujuan token akses yang dirujuk harus valid dan dalam status yang disetujui.

Contoh

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

Referensi Elemen

Referensi elemen menjelaskan elemen dan atribut kebijakan 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> atribut

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

Tabel berikut menjelaskan atribut yang umum untuk semua elemen induk kebijakan:

&lt;DisplayName&gt; elemen

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI dengan nama natural language yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt; elemen

Mengidentifikasi variabel tempat token akses berada. Misalnya, jika token akses tersebut dilampirkan ke pesan permintaan sebagai parameter kueri, tentukan request.queryparam.access_token. Anda dapat menggunakan variabel valid yang mereferensikan sebelumnya yang benar. Atau, bisa meneruskan string token literal (kasus jarang).

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

Atribut

&lt;Attributes&gt; elemen

Serangkaian atribut dalam profil token akses yang akan dimodifikasi atau diaugmentasi.

&lt;Attributes&gt;/&lt;Attribute&gt; elemen

Atribut individual yang akan diperbarui.

Atribut nama mengidentifikasi properti khusus profil token akses yang akan diperbarui. Contoh ini menunjukkan cara menggunakan nilai variabel yang direferensikan dan nilai statis.

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

Atribut

Variabel flow

Jika berhasil, variabel alur berikut akan ditetapkan:

• 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}

Skema

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Sebagai referensi, skema kebijakan tersedia di GitHub.

Referensi error

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.

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": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

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

Topik terkait

• Kebijakan OAuthV2
• Beranda OAuth
• Menyesuaikan Token dan Kode Otorisasi