OAuthV2Info politikasını sil

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

Ne?

Belirtilen OAuth V2 yetkilendirme kodunu veya erişim jetonunu siler.

Örnekler

Erişim jetonunu silin

Aşağıda, OAuth 2.0 erişim jetonunu silmek için kullanılan bir örnek politika verilmiştir. Aşağıdaki örnekte, adında bir üstbilgi arayarak istek mesajında silinecek erişim jetonu access_token

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

Yetkilendirme Kodunu Sil

Aşağıda, OAuth 2.0 yetkilendirme kodunu silmek için kullanılan bir örnek politika verilmiştir. Aşağıdaki örnek adında bir sorgu parametresini arayarak istek mesajında silinecek yetkilendirme kodunu bulur. code

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

Öğe Referansı

Öğe referansı, DeleteOAuthV2Info öğelerini ve özelliklerini açıklar politikası.

<?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> özellikler

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Özellik Açıklama Varsayılan Varlık
eş zamansız

Politikanın bir ileti dizisinde çalıştırılması gerektiğini belirtmek için true olarak ayarlayın istek/yanıt akışına hizmet veren havuzdan farklı bir havuza sahiptir. Varsayılan false.

Bu ayar yalnızca dahili optimizasyon için kullanılır.

false İsteğe bağlı
continueOnError

Çoğu politikanın bir hata oluştuğunda hata döndürmesi beklenir. Bunu ayarlayarak özelliğini true olarak ayarlarsanız Akış yürütme hata durumunda devam eder.

false İsteğe bağlı
etkin Bir politikanın uygulanıp uygulanmayacağını belirler. false olarak ayarlanırsa bir politika 'kapatılır' ve uygulanmaz (politika, Akış). true İsteğe bağlı
ad

Politikanın dahili adı. Bu ada, eklenecek adım öğelerinde referans verilir akışa uygulayabilirsiniz.

Not: Adda kullanabileceğiniz karakterler aşağıdakilerle sınırlıdır: A-Z0-9._\-$ %. Yönetim kullanıcı arayüzü, aşağıdakiler gibi ek kısıtlamalar uygular: Alfanümerik olmayan karakterler otomatik olarak kaldırılır.

Yok Zorunlu

&lt;AccessToken&gt; öğe

Silinecek erişim jetonunun bulunduğu değişkeni tanımlar. Örneğin, erişim jetonu, istek mesajına "access_token" adlı bir sorgu parametresi olarak eklendi. request.queryparam.access_token jeton. Veya düz jeton dizesini iletebilir (nadiren).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Varsayılan: Yok
Bulunma: <AccessToken> veya <AuthorizationCode> gereklidir.
Tür: Dize

Özellikler

Özellik Açıklama Varsayılan Varlık
referans

Erişim jetonu değişkeni Genellikle bir akış değişkeninden alınır. Örneğin, örnek: request.header.token veya request.queryparam.token.

Yok İsteğe bağlı

&lt;AuthorizationCode&gt; öğe

Silinecek yetkilendirme kodunun bulunduğu değişkeni tanımlar. Örneğin, yetkilendirme kodu, istek mesajına "code" adlı bir sorgu parametresi olarak eklenir, request.queryparam.code Jetona referans veren geçerli herhangi bir değişkeni kullanabilirsiniz. Veya düz jeton dizesini iletebilir (nadiren).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Varsayılan: Yok
Bulunma: <AccessToken> veya <AuthorizationCode> gereklidir.
Tür: Dize

Özellikler

Özellik Açıklama Varsayılan Varlık
referans

Erişim jetonu değişkeni Genellikle bir akış değişkeninden alınır. Örneğin, örnek: request.header.code veya request.queryparam.code.

Yok İsteğe bağlı

&lt;DisplayName&gt; öğe

Yönetim kullanıcı arayüzü proxy düzenleyicisinde politikayı etiketleyen doğal dil adı. Atlanırsa politika adı özelliği kullanılır.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Varsayılan: Politikanın name özelliğinin değeri.
Bulunma: İsteğe bağlı
Tür: Dize

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde döndürülen hata kodları ve hata mesajlarının yanı sıra Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Hata kuralları geliştirirken bu bilgilerin farkında olmanız önemlidir. hoşuma gitmesi için bir fırsattır. Daha fazla bilgi için Bilmeniz gerekenler Politika hataları ve Kullanım sorun.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Hata kodu HTTP durumu Neden
steps.oauth.v2.invalid_access_token 401 Politikaya gönderilen erişim jetonu geçersiz.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 Politikaya gönderilen yetkilendirme kodu geçersizdir.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Lütfen bkz. bu Apigee Topluluk gönderisine göz atın.

Dağıtım hataları

Dağıtım hataları hakkında bilgi için kullanıcı arayüzünde bildirilen mesaja bakın.

Hata değişkenleri

Bu değişkenler, politika çalışma zamanında bir hatayı tetiklediğinde ayarlanır.

Değişkenler Konum Örnek
fault.name="fault_name" fault_name, yukarıdaki Çalışma zamanı hataları tablosunda listelendiği gibi hatanın adıdır. Hata adı, hata kodunun son kısmıdır. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name, hataya neden olan politikanın kullanıcı tarafından belirtilen adıdır. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name, hataya neden olan politikanın kullanıcı tarafından belirtilen adıdır. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name, hataya neden olan politikanın kullanıcı tarafından belirtilen adıdır. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Örnek hata yanıtı

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

Örnek hata kuralı

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

Şema

Her politika türü bir XML şemasıyla (.xsd) tanımlanır. Referans olması amacıyla politika şemaları GitHub'da bulabilirsiniz.

İlgili konular