OAuthV2Info politikası belirle

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

Ne?

Bir erişim jetonuyla ilişkili özel özellikleri eklemenize veya güncellemenize olanak tanır. Özel özellikler arasında bölüm adı, müşteri kimliği veya oturum tanımlayıcısı gibi bilgiler yer alabilir. Ayrıca Jetonları ve Yetkilendirme Kodlarını Özelleştirme başlıklı makaleye de bakın.

Yalnızca özel özellikler ekleyebilir veya bunları değiştirebilirsiniz. Bu politikayı kullanarak kapsam, durum, expires_in, developer_email, client_id, org_name veya refresh_count gibi alanları değiştiremezsiniz. Bir özellik zaten varsa bu politika onu günceller. Bu seçenek yoksa politika tarafından eklenir. Referans verilen erişim jetonu geçerli ve onaylanmış durumda olmalıdır.

Örnekler

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

Öğe Referansı

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

<SetOAuthV2Info> özellikleri

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

&lt;DisplayName&gt; öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<AccessToken> öğesi

Erişim jetonunun bulunduğu değişkeni tanımlar. Örneğin, erişim jetonu istek mesajına 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>

Özellikler

<Attributes> öğesi

Erişim jetonu profilinde değiştirilecek veya artırılacak bir dizi özellik.

<Attributes>/<Attribute> öğesi

Güncellenecek bağımsız bir özellik.

Ad özelliği, erişim jetonu profilinin güncellenecek özel niteliğini tanımlar. Bu örnekte, referans verilen bir değişken değerinin ve statik bir değerin nasıl kullanılacağı gösterilmektedir.

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

Özellikler

Akış değişkenleri

Başarılı olursa aşağıdaki akış değişkenleri ayarlanır:

• oauthv2accesstoken.{policyName}.access_token
• oauthv2accesstoken.{policyName}.client_id
• oauthv2accesstoken.{policyName}.refresh_count
• oauthv2accesstoken.{policyName}.organization_name
• oauthv2accesstoken.{policyName}.expires_in //--in seconds
• oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
• oauthv2accesstoken.{policyName}.issued_at
• oauthv2accesstoken.{policyName}.status
• oauthv2accesstoken.{policyName}.api_product_list
• oauthv2accesstoken.{policyName}.token_type
• oauthv2accesstoken.{policyName}.{custom_attribute_name}

Şema

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

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından döndürülen hata kodları ve hata mesajları ile ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiler, hataları işlemek için hata kuralları geliştiriyorsanız önemlidir. Daha fazla bilgi edinmek için Politika hataları hakkında bilmeniz gerekenler ve Hataları ele alma başlıklı makaleleri inceleyin.

Çalışma zamanı hataları

Bu hatalar, politika yürütülürken oluşabilir.

Dağıtım hataları

Dağıtım hataları hakkında bilgi edinmek 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 hatayı tetiklediğinde ayarlanır.

Örnek hata yanıtı

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

Örnek hata kuralı

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

İlgili konular

• OAuthV2 politikası
• OAuth ana sayfası
• Jetonları ve Yetkilendirme Kodlarını Özelleştirme