Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Apa
Menghapus kode otorisasi atau token akses OAuth V2 yang ditentukan.
Contoh
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 ini
menemukan kode auth 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 DeleteOAuthV2Info lebih lanjut.
<?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
<DeleteOAuthV2Info> atribut
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
asinkron |
Setel ke Setelan ini hanya digunakan untuk pengoptimalan internal. |
salah | Opsional |
continueOnError |
Sebagian besar kebijakan diharapkan akan menampilkan error jika terjadi kegagalan. Dengan menetapkannya,
ke |
salah | Opsional |
diaktifkan | Menentukan apakah kebijakan diberlakukan atau tidak. Jika ditetapkan ke false ,
kebijakan 'dinonaktifkan', dan tidak diterapkan (meskipun kebijakan tetap terlampir
{i>flow<i}). |
true | Opsional |
nama |
Nama internal kebijakan. Nama ini dirujuk dalam elemen Langkah yang akan dilampirkan kebijakan ke Flow. Catatan: Karakter yang dapat Anda gunakan dalam nama dibatasi untuk:
|
T/A | Wajib |
<AccessToken> elemen
Mengidentifikasi variabel tempat token akses yang akan dihapus berada. Misalnya, jika
token akses dilampirkan ke pesan permintaan sebagai parameter kueri yang disebut "access_token", menentukan
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>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode> adalah
tidak diperlukan. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel alur. Sebagai
contoh: |
T/A | Opsional |
<AuthorizationCode> elemen
Mengidentifikasi variabel tempat kode otorisasi yang akan dihapus berada. Misalnya, jika
kode autentikasi dilampirkan untuk meminta pesan sebagai parameter kueri yang disebut "code", menentukan
request.queryparam.code
. Anda dapat menggunakan variabel valid apa pun yang mereferensikan token.
Atau, bisa meneruskan string token literal (kasus jarang).
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode> adalah
tidak diperlukan. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel alur. Sebagai
contoh: |
T/A | Opsional |
<DisplayName> elemen
Nama natural language yang memberi label kebijakan di editor proxy UI pengelolaan. Jika dihilangkan, digunakan atribut nama kebijakan.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Default: | Nilai atribut name kebijakan. |
Kehadiran: | Opsional |
Jenis: | String |
Referensi error
Bagian ini menjelaskan kode kesalahan dan pesan kesalahan yang dikembalikan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu kesalahan. 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 Penanganan kesalahan.
Error runtime
Error ini dapat terjadi saat kebijakan dijalankan.
Kode error | 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 | Harap lihat postingan Komunitas Apigee ini 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 | 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 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
). Sebagai referensi, skema kebijakan
tersedia di GitHub.