Kebijakan SetOAuthV2Info

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

Apa

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

Anda hanya dapat menambahkan atau mengubah atribut kustom. Anda tidak dapat menggunakan kebijakan ini untuk mengubah kolom seperti cakupan, status, expires_in, developer_email, client_id, org_name, atau refresh_count. Jika atribut sudah ada, kebijakan ini akan memperbaruinya. Jika tidak ada, kebijakan akan menambahkannya. Token akses yang direferensikan harus valid dan dalam status yang disetujui.

Contoh

Contoh dasar

Di bawah ini adalah contoh kebijakan yang digunakan untuk memperbarui token akses OAuth 2.0. Contoh di bawah ini menemukan token akses pada pesan permintaan dengan mencari parameter kueri yang disebut access_token. Saat token akses ditampilkan oleh aplikasi klien, kebijakan di bawah ini akan menemukan token akses dalam parameter kueri. Kemudian, kebijakan ini akan memperbarui profil token akses. Kebijakan ini menambahkan properti kustom yang disebut department.id ke profil. 

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

Atribut <SetOAuthV2Info>

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

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

Atribut Deskripsi Default Ketersediaan
name

Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter.

Secara opsional, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural language yang berbeda.

 T/A Wajib
continueOnError

Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Diharapkan untuk sebagian besar kebijakan.

Setel ke true agar eksekusi alur dapat dilanjutkan bahkan setelah kebijakan gagal.

 salah Opsional
enabled

Setel ke true untuk menerapkan kebijakan.

Setel ke false untuk menonaktifkan kebijakan. Kebijakan ini tidak akan ditegakkan meskipun tetap terikat pada alur.

 true Opsional
async

Atribut ini tidak digunakan lagi.

 salah Tidak digunakan lagi

&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>
Default

T/A

Jika Anda menghapus elemen ini, nilai atribut name kebijakan akan menjadi data
Ketersediaan Opsional
Jenis String

Elemen <AccessToken>

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: T/A
Ketersediaan: Wajib
Jenis: String

Atribut

Atribut Deskripsi Default Ketersediaan
ref

Variabel token akses. Biasanya, diambil dari variabel alur.

 T/A Opsional

Elemen <Attributes>

Kumpulan atribut dalam profil token akses yang akan diubah atau ditambah.

Default: T/A
Ketersediaan: Wajib
Jenis: T/A

Elemen <Attributes>/<Attribute>

Atribut individual yang akan diperbarui.

Atribut nama mengidentifikasi properti kustom 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>
Default: T/A
Ketersediaan: Opsional
Jenis: T/A

Atribut

Atribut Deskripsi Default Ketersediaan
nama Nama atribut profil yang akan ditambahkan atau diubah. T/A
ref

Nilai yang akan ditetapkan ke atribut profil.

 T/A Opsional

Variabel alur

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

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang ditetapkan oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode kesalahan Status HTTP Penyebab
steps.oauth.v2.access_token_expired 500 Masa berlaku token akses yang dikirim ke kebijakan telah berakhir.
steps.oauth.v2.invalid_access_token 500 Token akses yang dikirim ke kebijakan tidak valid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Lihat postingan Komunitas Apigee ini untuk mengetahui informasi tentang cara memecahkan masalah error ini.

Error saat deployment

Lihat pesan yang dilaporkan di UI untuk mengetahui informasi tentang error deployment.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime.

Variabel Di mana Contoh
fault.name="fault_name" fault_name adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name adalah nama kebijakan yang ditentukan pengguna yang menyebabkan kesalahan. oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name adalah nama kebijakan yang ditentukan pengguna yang menyebabkan kesalahan. oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name adalah nama kebijakan yang ditentukan pengguna yang menyebabkan kesalahan. oauthV2.SetTokenInfo.cause = Invalid Access Token

Contoh respons error

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

Contoh aturan kesalahan

<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