Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi Apigee Edge.
Apa
Menghapus kode otorisasi OAuth V2 atau token akses yang ditentukan.
Kebijakan ini merupakan Kebijakan yang dapat diperluas, dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau pemanfaatan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.
Sampel
Hapus Token Akses
Berikut adalah contoh kebijakan yang digunakan untuk menghapus token akses OAuth 2.0. Contoh di bawah ini menemukan
token akses yang akan dihapus pada pesan permintaan dengan mencari header yang disebut
access_token
.
<DeleteOAuthV2Info name="DeleteAccessToken"> <AccessToken ref="request.header.access_token"></AccessToken> </DeleteOAuthV2Info>
Hapus Kode Autentikasi
Berikut adalah contoh kebijakan yang digunakan untuk menghapus kode otorisasi OAuth 2.0. Contoh di bawah menemukan kode autentikasi yang akan dihapus pada pesan permintaan dengan mencari parameter kueri yang disebut code
.
<DeleteOAuthV2Info name="DeleteAuthCode"> <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode> </DeleteOAuthV2Info>
Referensi Elemen
Referensi elemen menjelaskan elemen dan atribut kebijakan DeleteOAuthV2Info.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1"> <DisplayName>Delete OAuth v2.0 Info 1</DisplayName> <AccessToken ref={some-variable}></AccessToken> <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>--> <Attributes/> </DeleteOAuthV2Info
Atribut<DeleteOAuthV2Info>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Atribut | Deskripsi | Default | Kehadiran |
---|---|---|---|
async |
Setel ke Setelan ini hanya digunakan untuk pengoptimalan internal. |
false | Opsional |
continueOnError |
Sebagian besar kebijakan diperkirakan akan menampilkan error jika terjadi kegagalan. Dengan menetapkan atribut ini ke |
false | Opsional |
diaktifkan | Menentukan apakah kebijakan diterapkan atau tidak. Jika disetel ke false , kebijakan akan 'dinonaktifkan', dan tidak diterapkan (meskipun kebijakan tetap melekat pada
Flow). |
true | Opsional |
name |
Nama internal kebijakan. Nama ini dirujuk dalam elemen Langkah untuk melampirkan kebijakan ke Flow. Catatan: Karakter yang dapat Anda gunakan dalam nama dibatasi untuk:
|
T/A | Diperlukan |
Elemen <AccessToken>
Mengidentifikasi variabel tempat token akses yang akan dihapus berada. Misalnya, jika token akses dilampirkan ke pesan permintaan sebagai parameter kueri yang disebut "access_token", tentukan request.queryparam.access_token
. Anda dapat menggunakan variabel valid apa pun yang mereferensikan
token. Atau, dapat meneruskan string token literal ({i>rare case<i}).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode>
wajib ada. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Kehadiran |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel flow. Contoh: |
T/A | Opsional |
Elemen <AuthorizationCode>
Mengidentifikasi variabel tempat kode otorisasi yang akan dihapus berada. Misalnya, jika kode autentikasi dilampirkan ke pesan permintaan sebagai parameter kueri yang disebut "code", tentukan request.queryparam.code
. Anda dapat menggunakan variabel valid yang merujuk pada token.
Atau, dapat meneruskan string token literal ({i>rare case<i}).
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode>
wajib ada. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Kehadiran |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel flow. Contoh: |
T/A | Opsional |
Elemen<DisplayName>
Nama bahasa alami yang memberi label kebijakan di editor proxy UI Apigee. Jika dihilangkan, atribut nama kebijakan akan digunakan.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Default: | Nilai atribut name kebijakan. |
Kehadiran: | Opsional |
Jenis: | String |
Referensi error
Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah 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 dieksekusi.
Kode kesalahan | Status HTTP | Penyebab |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 |
Token akses yang dikirim ke kebijakan tidak valid. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 |
Kode otorisasi yang dikirim ke kebijakan tidak valid. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 |
Lihat Verifikasi Token Akses Oauth2.0 menampilkan error "Invalid API call as no apiproduct match found" untuk mendapatkan informasi tentang pemecahan 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 | Dari 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 menampilkan kesalahan. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. | oauthV2.DeleteTokenInfo.cause = Invalid Access Token |
Contoh respons error
{ "fault": { "faultstring": "Invalid Access Token", "detail": { "errorcode": "keymanagement.service.invalid_access_token" } } }
Contoh aturan kesalahan
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults"> <Step> <Name>AM-InvalidTokenResponse</Name> </Step> <Condition>(fault.name = "invalid_access_token")</Condition> </FaultRule>
Skema
Setiap jenis kebijakan ditentukan oleh skema XML (.xsd
). Untuk referensi, skema kebijakan tersedia di GitHub.