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

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

Kimlik doğrulama kodunu silme

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

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
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

Hata referansı

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>

Şema

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

İlgili konular