Kebijakan DeleteOAuthV2Info

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

ikon kebijakan

Apa

Menghapus kode otorisasi atau token akses OAuth V2 yang ditentukan.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaannya, lihat Jenis kebijakan.

Sampel

Menghapus Token Akses

Di bawah ini adalah contoh kebijakan yang digunakan untuk menghapus token akses OAuth 2.0. Contoh di bawah 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>

Menghapus Kode Otorisasi

Berikut adalah contoh kebijakan yang digunakan untuk menghapus kode otorisasi OAuth 2.0. Contoh di bawah menemukan kode otorisasi 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
asinkron

Setel ke true untuk menentukan bahwa kebijakan harus dijalankan di kumpulan thread yang berbeda dengan kumpulan yang melayani alur permintaan/respons. Default-nya adalah false.

Setelan ini hanya digunakan untuk pengoptimalan internal.

 false Opsional
continueOnError

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

 false Opsional
diaktifkan Menentukan apakah kebijakan diterapkan atau tidak. Jika disetel ke false, kebijakan akan 'dinonaktifkan' dan tidak diberlakukan (meskipun kebijakan tetap terlampir ke Flow). true Opsional
nama

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Default: T/A
Kehadiran: <AccessToken> atau <AuthorizationCode> harus ada.
Jenis: String

Atribut

Atribut Deskripsi Default Kehadiran
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 yang disebut "code", tentukan request.queryparam.code. Anda dapat menggunakan variabel valid yang mereferensikan token. Atau, dapat meneruskan string token literal (kasus yang jarang terjadi).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Default: T/A
Kehadiran: <AccessToken> atau <AuthorizationCode> harus ada.
Jenis: String

Atribut

Atribut Deskripsi Default Kehadiran
ref

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

 T/A Opsional

Elemen <DisplayName>

Nama bahasa alami yang memberi label pada 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 error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode kerusakan 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 "Panggilan API tidak valid karena tidak ada kecocokan apiproduct" untuk mengetahui informasi tentang pemecahan masalah error ini.

Error saat deployment

Lihat pesan yang dilaporkan di UI untuk mengetahui informasi tentang error deployment.

Variabel error

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime.

Variabel Dari mana Contoh
fault.name="fault_name" fault_name adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan error. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Contoh respons error

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Contoh aturan error

<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.

Topik terkait