DeleteOAuthV2Info

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

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

Apa

Menghapus token akses atau kode otorisasi OAuth V2 yang ditentukan.

Contoh

Menghapus Token Akses

Di bawah ini 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 bernama access_token.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

Di bawah ini adalah contoh kebijakan yang digunakan untuk menghapus kode otorisasi OAuth 2.0. Contoh di bawah ini menemukan kode otorisasi yang akan dihapus pada pesan permintaan dengan mencari parameter kueri bernama 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

Tetapkan ke true untuk menentukan bahwa kebijakan harus dijalankan dalam kumpulan thread yang berbeda dengan kumpulan yang melayani alur permintaan/respons. Default adalah false.

Setelan ini hanya digunakan untuk pengoptimalan internal.

 false Opsional
continueOnError

Sebagian besar kebijakan diharapkan menampilkan error saat terjadi kegagalan. Dengan menetapkan atribut ini atribut ke true, eksekusi Alur akan berlanjut jika terjadi kegagalan.

 false Opsional
enabled Menentukan apakah kebijakan diterapkan atau tidak. Jika ditetapkan ke false, kebijakan akan 'dinonaktifkan', dan tidak diterapkan (meskipun kebijakan tetap terlampir ke Alur). true Opsional
name

Nama internal kebijakan. Nama ini direferensikan dalam elemen Langkah untuk melampirkan kebijakan ke Alur.

Catatan: Karakter yang dapat Anda gunakan dalam nama dibatasi untuk: A-Z0-9._\-$ %. UI Pengelolaan menerapkan batasan tambahan, seperti menghapus karakter yang bukan alfanumerik secara otomatis.

 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 bernama "access_token", tentukan request.queryparam.access_token. Anda dapat menggunakan variabel valid apa pun yang mereferensikan token. Atau, dapat meneruskan string token literal (kasus yang jarang terjadi).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: T/A
Ketersediaan: Either <AccessToken> atau <AuthorizationCode> diperlukan.
Jenis: String

Atribut

Atribut Deskripsi Default Ketersediaan
ref

Variabel token akses. Biasanya, diambil dari variabel alur. Misalnya: request.header.token atau request.queryparam.token.

 T/A Opsional

Elemen <AuthorizationCode>

Mengidentifikasi variabel tempat kode otorisasi yang akan dihapus berada. Misalnya, jika kode otorisasi dilampirkan ke pesan permintaan sebagai parameter kueri bernama "code", tentukan request.queryparam.code. Anda dapat menggunakan variabel valid apa pun yang mereferensikan token. Atau, dapat meneruskan string token literal (kasus yang jarang terjadi).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: T/A
Ketersediaan: Either <AccessToken> atau <AuthorizationCode> diperlukan.
Jenis: String

Atribut

Atribut Deskripsi Default Ketersediaan
ref

Variabel token akses. Biasanya, diambil dari variabel alur. Misalnya: contoh: request.header.code atau request.queryparam.code.

 T/A Opsional

<DisplayName> elemen

Nama bahasa alami 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.
Ketersediaan: 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 otorisasi):

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