Kebijakan DeleteOAuthV2Info

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

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

Referensi error

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.oauth.v2.invalid_access_token 401 The access token sent to the policy is invalid.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 The authorization code sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see this Apigee Community post for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Example error response

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

Example fault rule

<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