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>
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 | Ketersediaan |
---|---|---|---|
async |
Setel ke Setelan ini hanya digunakan untuk pengoptimalan internal. |
false | Opsional |
continueOnError |
Sebagian besar kebijakan diperkirakan menampilkan error saat terjadi kegagalan. Dengan menetapkan atribut
ini ke |
false | Opsional |
diaktifkan | Menentukan apakah kebijakan diberlakukan atau tidak. Jika ditetapkan ke false , kebijakan akan 'dinonaktifkan', dan tidak diterapkan (meskipun kebijakan tetap melekat pada Flow). |
true | Opsional |
name |
Nama internal kebijakan. Nama ini direferensikan dalam elemen Langkah untuk melampirkan kebijakan ke Flow. Catatan: Karakter yang dapat Anda gunakan dalam nama dibatasi untuk:
|
T/A | Wajib |
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 (rare case).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode>
wajib ada. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel flow. Misalnya: |
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 token.
Atau, dapat meneruskan string token literal (rare case).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: | T/A |
Kehadiran: | <AccessToken> atau <AuthorizationCode>
wajib ada. |
Jenis: | String |
Atribut
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
referensi |
Variabel token akses. Biasanya, diambil dari variabel flow. Misalnya: |
T/A | Opsional |
Elemen <DisplayName>
Nama natural-language yang memberi label kebijakan di editor proxy UI pengelolaan. Jika dihilangkan, atribut nama kebijakan akan digunakan.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Default: | Nilai atribut name kebijakan. |
Kehadiran: | Opsional |
Jenis: | String |
Output
Jika berhasil, kebijakan akan menampilkan status 200.
Jika gagal, kebijakan akan menampilkan 404 dan output yang mirip dengan berikut ini (bergantung pada apakah Anda menghapus token akses atau kode autentikasi):
HTTP/1.1 404 Not Found Content-Type: application/json Content-Length: 144 Connection: keep-alive {"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}
Skema
Setiap jenis kebijakan ditentukan oleh skema XML (.xsd
). Sebagai referensi, skema kebijakan tersedia di GitHub.