DeleteOAuthV2Info

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

Tentang | Contoh | Elemen referensi | Output | Skema | Topik terkait

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 ini menemukan kode auth yang akan dihapus dalam pesan permintaan dengan mencari parameter kueri 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 true untuk menentukan bahwa kebijakan harus dijalankan di thread kumpulan yang berbeda dari kumpulan yang melayani alur permintaan/respons. Default adalah false.

Setelan ini hanya digunakan untuk pengoptimalan internal.

 salah Opsional
continueOnError

Sebagian besar kebijakan diharapkan akan menampilkan error jika terjadi kegagalan. Dengan menetapkannya, ke true, eksekusi Flow akan berlanjut jika gagal.

 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: A-Z0-9._\-$ %. UI Pengelolaan menerapkan pembatasan tambahan, seperti secara otomatis menghapus karakter yang bukan alfanumerik.

 T/A Wajib

&lt;AccessToken&gt; 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: request.header.token atau request.queryparam.token.

 T/A Opsional

&lt;AuthorizationCode&gt; 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).

 <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: request.header.code atau request.queryparam.code.

 T/A Opsional

&lt;DisplayName&gt; 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

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 auth):

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.

Topik terkait