Kebijakan SetOAuthV2Info

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

ikon kebijakan

Apa

Memungkinkan Anda menambahkan atau memperbarui atribut khusus 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 khusus. Anda tidak dapat menggunakan kebijakan ini untuk mengubah kolom seperti scope, 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 dirujuk harus valid dan dalam status yang disetujui.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Sampel

Contoh dasar

Berikut 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 akan menemukan token akses dalam parameter kueri. Kemudian, token tersebut akan memperbarui profil token akses. Tindakan ini akan menambahkan properti kustom bernama 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 Kehadiran
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 pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.

 T/A Wajib
continueOnError

Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan.

Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga:

 false Opsional
enabled

Tetapkan ke true untuk menerapkan kebijakan.

Tetapkan ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.

 benar Opsional
async

Atribut ini tidak digunakan lagi.

 false Tidak digunakan lagi

Elemen <DisplayName>

Gunakan selain atribut name untuk melabeli kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.

<DisplayName>Policy Display Name</DisplayName>
Default

T/A

Jika Anda menghapus elemen ini, nilai atribut name kebijakan akan digunakan.
Kehadiran 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 yang mereferensikan token. Atau, dapat meneruskan string token literal (kasus jarang terjadi).

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

Atribut

Atribut Deskripsi Default Kehadiran
ref

Variabel token akses. Biasanya, diambil dari variabel flow.

 T/A Opsional

Elemen <Attributes>

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

Default: T/A
Kehadiran: 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
Kehadiran: Opsional
Jenis: T/A

Atribut

Atribut Deskripsi Default Kehadiran
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 error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kerusakan 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 Verifikasi Token Akses Oauth2.0 menampilkan error "Panggilan API tidak valid karena tidak ada kecocokan apiproduct" 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 error

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime.

Variabel Dari mana Contoh
fault.name="fault_name" fault_name adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.SetTokenInfo.cause = Invalid Access Token

Contoh respons error

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

Contoh aturan error

<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