OAuthV2Info politikası belirle

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

Ne?

Bir erişim jetonuyla ilişkilendirilmiş özel özellikleri eklemenizi veya güncellemenizi sağlar. Özel özellikler {0}bölüm adı, müşteri kimliği veya oturum tanımlayıcısı gibi bilgiler içerebilir. Şu kaynakları da inceleyin Jetonları ve Yetkilendirme Kodları bölümüne bakın.

Yalnızca özel özellikler ekleyebilir veya mevcut özel özellikleri değiştirebilirsiniz. Bu politikayı aşağıdaki gibi alanları değiştirmek için kullanamazsınız: kapsam, durum, sona erme, geliştirici_e-postası, istemci_kimliği, kuruluş_adı veya yenileme_count. Bir özelliği zaten mevcutsa bu politika, özelliği günceller. Böyle bir yer yoksa politika tarafından eklenir. İlgili içeriği oluşturmak için kullanılan başvurulan erişim jetonu geçerli ve onaylanmış bir 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> özellikler

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

&lt;AccessToken&gt; öğe

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>

Özellikler

&lt;Attributes&gt; öğe

Erişim jetonu profilinde değiştirilecek veya genişletilecek bir özellik grubu.

&lt;Attributes&gt;/&lt;Attribute&gt; öğe

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

name özelliği, kullanılacak erişim jetonu profilinin özel özelliğini tanımlar güncellendi. Bu örnekte, referans verilen bir değişken değerinin ve statik 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

İşlem başarılı olduğunda, aşağıdaki akış değişkenleri ayarlanacaktı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ıyla (.xsd) tanımlanır. Referans olması amacıyla politika şemaları GitHub'da bulabilirsiniz.

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.

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.

Ö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ı Özelleştirme ve yetkilendirme kodları