GetOAuthV2Info politikası

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

Ne?

Erişim jetonları, yenileme jetonları, yetkilendirme kodları ve istemci uygulamasının özelliklerini alır özelliklerine yer verir ve değişkenleri bu özelliklerin değerleriyle doldurur.

Bu politika, dinamik, koşullu davranışı bir değere göre yapılandırmanız gerektiğinde yararlı olur belirtmelisiniz. Jeton doğrulaması her gerçekleştiğinde, değişkenler otomatik olarak doldurulur değerleriyle birlikte kullanabilirsiniz. Ancak jeton doğrulamasının gerçekleşmediği durumlarda , bu özelliği bir jetonun özellik değerleriyle değişkenleri açık bir şekilde doldurmak için kullanabilir. Şu kaynakları da inceleyin Jetonları ve Yetkilendirme Kodları bölümüne bakın.

Bu politikaya ilettiğiniz bir erişim jetonu geçerli olmalıdır, aksi takdirde politika bir invalid_access_token hata.

Örnekler

Aşağıdaki örnekler, OAuth V2 Bilgisini Alma politikasını kullanarak, bileşenlerine ayırabilir ve ardından bu bilgilere kod içinden erişebilirsiniz.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

Öğe Referansı

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

<GetOAuthV2Info> özellikler

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-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 jetonu için profil alır. Örneğin, erişim jetonu dizesi veya düz jeton dizesi (nadir durum). Bu örnekte erişim jetonu bir istekte geçirilen sorgu parametresinden alınır. <ignoreAccessTokenStatus> öğesine dokunun.

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

&lt;AuthorizationCode&gt; öğe

Yetkilendirme kodu için profili alır. Parametrenizde yetkilendirme kodu dizesi veya düz jeton dizesi (nadir durumda olan bir durum). Bu örnekte, yetkilendirme kodu bir istekte geçirilen sorgu parametresinden alınır. Bu işlemi için "Akış değişkenleri" bölümüne bakın.

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

&lt;ClientId&gt; öğe

Bir istemci kimliğiyle ilgili bilgileri getirir. Bu örnekte, sorgu parametresinden alınır. Bu işlemle doldurulan değişkenlerin bir listesi için "Akış değişkenleri" bölümüne bakın.

<ClientId ref="request.queryparam.client_id"></ClientId>

&lt;IgnoreAccessTokenStatus&gt; öğe

Jetonun süresi dolmuş veya jeton iptal edilmiş olsa bile jeton bilgilerini döndürür. Bu öğe yalnızca erişim jetonlarıyla birlikte kullanılmalıdır. Yenileme jetonları ve yetkilendirme gibi diğer varlıklarla ilgili bilgiler kodları, varsayılan olarak durumlarına bakılmaksızın döndürülür.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

&lt;RefreshToken&gt; öğe

Yenileme jetonuna ilişkin profili alır. Örneğin, yenileme jetonu dizesini veya düz jeton dizesi (nadiren karşılaşılan) Bu örnekte, yenileme jetonu bir istekte geçirilen sorgu parametresinden alınır. Bu işlemi için "Akış değişkenleri" bölümüne bakın.

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

Akış değişkenleri

GetOAuthV2Info politikası bu değişkenleri doldurur ve genellikle ancak henüz bir izin veya doğrulama gerçekleşmediyse profil verilerine ihtiyaç duyuyor. .

İstemci kimliği değişkenleri

Bu değişkenler, ClientId öğesi ayarlandığında doldurulur:

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

Erişim jetonu değişkenleri

Bu değişkenler, AccessToken öğesi ayarlandığında doldurulur:

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Yetkilendirme kodu değişkenleri

Bu değişkenler, AuthorizationCode öğesi ayarlandığında doldurulur:

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

Jeton değişkenlerini yenileyin

Bu değişkenler, RefreshToken öğesi ayarlandığında doldurulur:

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Ş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. Aşağıda gösterilen hata adları dizedir fault.name değişkenine atanır. Hatayı Göster değişkenler bölümüne bakı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, politika çalışma zamanında bir hatayı tetiklediğinde ayarlanır.

Örnek hata yanıtı

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Örnek hata kuralı

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

İlgili konular

• OAuthV2 politikası
• OAuth ana sayfası
• Jetonları Özelleştirme ve yetkilendirme kodları