OAuthV2Bilgilerini Silme

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

Hakkında | Örnekler | Öğe referansı | Çıkış | Şema | İlgili konular

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 aranarak istek mesajında silinecek erişim jetonu bulunur.

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

Aşağıda, OAuth 2.0 yetkilendirme kodunu silmek için kullanılan örnek bir politika verilmiştir. Aşağıdaki örnekte, code adlı bir sorgu parametresi aranarak istek mesajında silinecek yetkilendirme kodu bulunur.

<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
eş zamansız

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 olarak ayarlayın. Varsayılan değer false'dir.

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

 yanlış İsteğe bağlı
continueOnError

Çoğu politikanın bir hata oluştuğunda hata döndürmesi beklenir. Bu özelliği true olarak ayarladığınızda akış yürütme işlemi başarısız olsa bile devam eder.

 yanlış İsteğe bağlı
etkin Bir politikanın uygulanıp uygulanmayacağını belirler. false olarak ayarlanırsa politika "devre dışı bırakılır" ve uygulanmaz (politika bir Akış'a bağlı kalmaya devam etse bile). doğru İsteğe bağlı
ad

Politikanın dahili adı. Bu ada, politikayı bir akışa eklemek için Adım öğelerinde referans verilir.

Not: Adlarda 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ırma gibi ek kısıtlamalar uygular.

 Yok Zorunlu

<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. Jetonu referans alan geçerli bir değişken kullanabilirsiniz. Alternatif olarak, gerçek jeton dizesi de iletilebilir (nadir durum).

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

Özellikler

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

Erişim jetonu değişkeni. Genellikle 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 istek mesajına "code" adlı bir sorgu parametresi olarak eklenmişse request.queryparam.code değerini belirtin. Jetonu referans alan geçerli bir değişken kullanabilirsiniz. Alternatif olarak, gerçek jeton dizesi de iletilebilir (nadir durum).

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

Özellikler

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

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

 Yok İsteğe bağlı

<DisplayName> öğesi

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.
Mevcut olma: İsteğe bağlı
Tür: Dize

Çıkış

Başarılı olursa politika 200 durumunu döndürür.

İşlem başarısız olursa politika 404 döndürür ve aşağıdakine benzer bir çıkış verir (erişim jetonu mu yoksa yetkilendirme kodu mu sildiğinize bağlı olarak):

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"}}}

Şema

Her politika türü bir XML şeması (.xsd) ile tanımlanır. Referans olarak politika şemaları GitHub'da mevcuttur.

İlgili konular