OAuthV2Info politikasını sil

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Ne

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

Örnekler

Erişim Jetonunu Silme

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

<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 politika örneği verilmiştir. Aşağıdaki örnekte, code adlı bir sorgu parametresi arayarak istek mesajında silinecek yetkilendirme kodu gösterilmektedir.

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

Öğe Referansı

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

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

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

Politikanın, istek/yanıt akışına hizmet veren havuzdan farklı bir iş parçacığı havuzunda çalıştırılması gerektiğini belirtmek için true değerine ayarlayın. false varsayılandır.

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

 false İsteğe bağlı
continueOnError

Bir hata meydana geldiğinde çoğu politikanın hata döndürmesi beklenir. Bu özellik true olarak ayarlandığında, akış yürütme hata durumunda devam eder.

 false İsteğe bağlı
etkin Bir politikanın uygulanıp uygulanmadığını belirler. false değerine ayarlanırsa bir politika "devre dışı bırakılır" ve zorunlu kılınmaz (politika bir Akış'a bağlı kalsa bile). true İsteğe bağlı
ad

Politikanın dahili adı. Politikayı bir Akışa eklemek için Adım öğelerinde bu ada referans verilir.

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

 Yok Gerekli

<AccessToken> öğesi

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 eklenmişse request.queryparam.access_token değerini belirtin. Jetona referans veren geçerli herhangi bir değişkeni kullanabilirsiniz. Ya da değişmez jeton dizesini iletebilir (nadiren kullanılan büyük/küçük harf).

 <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. Tipik olarak bir akış değişkeninden alınır. Örneğin: request.header.token veya request.queryparam.token.

 Yok İsteğe bağlı

<AuthorizationCode> öğesi

Silinecek yetkilendirme kodunun bulunduğu değişkeni tanımlar. Örneğin, yetkilendirme kodu "kod" adlı bir sorgu parametresi olarak istek mesajına eklenmişse request.queryparam.code değerini belirtin. Jetona referans veren geçerli herhangi bir değişkeni kullanabilirsiniz. Ya da değişmez jeton dizesini iletebilir (nadiren kullanılan büyük/küçük harf).

 <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. Tipik olarak bir akış değişkeninden alınır. Örneğin: request.header.code veya request.queryparam.code.

 Yok İsteğe bağlı

<DisplayName> öğesi

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde 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 Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar 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çersiz.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Bu hatayı giderme konusunda bilgi edinmek için lütfen bu Apigee Topluluğu yayınına 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, bu politika çalışma zamanında bir hata tetiklediğinde ayarlanır.

Değişkenler Konum Örnek
fault.name="fault_name" fault_name, yukarıdaki Çalışma zamanı hataları tablosunda listelenen 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"
    }
  }
}

Hata kuralı örneği

<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ı (.xsd) ile tanımlanır. Referans olarak, GitHub'da politika şemaları bulunabilir.

İlgili konular