GetOAuthV2Info नीति

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

क्या

ऐक्सेस टोकन, रीफ़्रेश टोकन, ऑथराइज़ेशन कोड, और क्लाइंट ऐप्लिकेशन के एट्रिब्यूट मिलते हैं एट्रिब्यूट इस्तेमाल करता है और वैरिएबल को उन एट्रिब्यूट की वैल्यू से पॉप्युलेट करता है.

यह नीति तब काम आती है, जब आपको वैल्यू के आधार पर डाइनैमिक और कंडिशनल व्यवहार को कॉन्फ़िगर करने की ज़रूरत हो उसे किसी टोकन या ऑथराइज़ेशन कोड में डालें. जब भी टोकन की पुष्टि की जाती है, वैरिएबल अपने-आप पॉप्युलेट हो जाते हैं . हालांकि, टोकन की पुष्टि नहीं होने के मामलों में, आपको इस सुविधा का इस्तेमाल करके, किसी टोकन की एट्रिब्यूट वैल्यू के साथ वैरिएबल को साफ़ तौर पर भरा जा सकता है. इन्हें भी देखें टोकन को कस्टमाइज़ करना और ऑथराइज़ेशन कोड.

इस नीति को पास किया जाने वाला ऐक्सेस टोकन मान्य होना चाहिए. ऐसा न करने पर, नीति invalid_access_token गड़बड़ी.

सैंपल

नीचे दिए गए सैंपल, OAuth V2 की जानकारी पाने की नीति का इस्तेमाल करते हैं. इससे, को अपडेट और फिर कोड में उस जानकारी को ऐक्सेस करता है.

<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");

एलिमेंट का रेफ़रंस

एलिमेंट के रेफ़रंस में, GetOAuthV2Info नीति के एलिमेंट और एट्रिब्यूट के बारे में पता चलता है.

<?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> एट्रिब्यूट

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

यहां दी गई टेबल में, ऐसे एट्रिब्यूट के बारे में बताया गया है जो नीति के सभी पैरंट एलिमेंट में एक जैसे होते हैं:

&lt;DisplayName&gt; एलिमेंट

इस कॉलम में नीति को लेबल करने के लिए, name एट्रिब्यूट के साथ-साथ इस्तेमाल करें मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर, जिसका नाम अलग और सामान्य भाषा में है.

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt; एलिमेंट

ऐक्सेस टोकन के लिए प्रोफ़ाइल को वापस लाता है. आप कोई ऐसा वैरिएबल पास करते हैं जिसमें ऐक्सेस टोकन स्ट्रिंग या लिटरल टोकन स्ट्रिंग (बहुत कम इस्तेमाल होने वाला केस). इस उदाहरण में, ऐक्सेस टोकन यह किसी अनुरोध में पास किए गए क्वेरी पैरामीटर से मिलता है. <ignoreAccessTokenStatus> का इस्तेमाल करें एलिमेंट शामिल करें.

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

&lt;AuthorizationCode&gt; एलिमेंट

ऑथराइज़ेशन कोड के लिए प्रोफ़ाइल को वापस लाता है. आप कोई ऐसा वैरिएबल पास करते हैं जिसमें यह शामिल है ऑथराइज़ेशन कोड स्ट्रिंग या लिटरल टोकन स्ट्रिंग (बहुत कम इस्तेमाल होने वाला केस). इस उदाहरण में, ऑथराइज़ेशन कोड यह किसी अनुरोध में पास किए गए क्वेरी पैरामीटर से मिलता है. इससे भरी गई वैरिएबल की सूची के लिए "फ़्लो वैरिएबल" देखें.

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

&lt;ClientId&gt; एलिमेंट

क्लाइंट आईडी से जुड़ी जानकारी हासिल करता है. इस उदाहरण में, Client-ID को वापस लाया गया है अनुरोध में पास किए गए क्वेरी पैरामीटर से मिलती है. इस कार्रवाई से भरे गए वैरिएबल की सूची के लिए, "फ़्लो वैरिएबल" देखें.

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

&lt;IgnoreAccessTokenStatus&gt; एलिमेंट

टोकन की समयसीमा खत्म होने या उसे रद्द कर दिए जाने पर भी टोकन की जानकारी दिखाता है. यह एलिमेंट सिर्फ़ इसे ऐक्सेस टोकन के साथ इस्तेमाल किया जा सकता है. रीफ़्रेश टोकन और अनुमति देने जैसी अन्य इकाइयों की जानकारी कोड डिफ़ॉल्ट रूप से, उनकी स्थिति पर ध्यान दिए बिना वापस दिखाए जाते हैं.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

&lt;RefreshToken&gt; एलिमेंट

रीफ़्रेश टोकन के लिए प्रोफ़ाइल को वापस लाता है. आप कोई ऐसा वैरिएबल पास करते हैं जिसमें रीफ़्रेश टोकन स्ट्रिंग या लिटरल टोकन स्ट्रिंग (बहुत कम इस्तेमाल होने वाला केस). इस उदाहरण में, रीफ़्रेश टोकन यह किसी अनुरोध में पास किए गए क्वेरी पैरामीटर से मिलता है. इससे भरी गई वैरिएबल की सूची के लिए "फ़्लो वैरिएबल" देखें.

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

फ़्लो वैरिएबल

GetOAuthV2Info नीति इन वैरिएबल को पॉप्युलेट करती है और आम तौर पर इसका इस्तेमाल उन मामलों में किया जाता है, जहां आप को प्रोफ़ाइल डेटा की ज़रूरत है, लेकिन अभी तक अनुमति या पुष्टि नहीं हुई है. .

Client-ID वैरिएबल

ClientId एलिमेंट सेट होने पर, इन वैरिएबल में जानकारी अपने-आप भर जाती है:

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}

टोकन वैरिएबल ऐक्सेस करें

AccessToken एलिमेंट सेट होने पर, इन वैरिएबल में जानकारी अपने-आप भर जाती है:

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

ऑथराइज़ेशन कोड वैरिएबल

AuthorizationCode एलिमेंट के सेट होने पर इन वैरिएबल का डेटा जनरेट होता है:

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}

टोकन वैरिएबल रीफ़्रेश करें

RefreshToken एलिमेंट के सेट होने पर, इन वैरिएबल में जानकारी अपने-आप भर जाती है:

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

स्कीमा

हर तरह की नीति को एक्सएमएल स्कीमा (.xsd) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा GitHub पर उपलब्ध हैं.

गड़बड़ी का रेफ़रंस

इस सेक्शन में, गड़बड़ी के कोड और गड़बड़ी के मैसेज के बारे में बताया गया है. साथ ही, इन गड़बड़ियों के वैरिएबल के बारे में भी बताया गया है, जो Edge की मदद से सेट किए जाते हैं. यह जानकारी जानना ज़रूरी है कि क्या आप गड़बड़ियों को ठीक करता है. ज़्यादा जानने के लिए, आपके लिए ज़रूरी जानकारी देखें नीति से जुड़ी गड़बड़ियों और हैंडलिंग के बारे में जानकारी गलतियां.

रनटाइम की गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं. नीचे दिखाए गए गड़बड़ी के नाम स्ट्रिंग हैं जिन्हें कोई गड़बड़ी होने पर fault.name वैरिएबल को असाइन किया जाता है. गलती देखें 'वैरिएबल' सेक्शन में जाएं.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

डिप्लॉयमेंट की गड़बड़ियों के बारे में जानकारी के लिए, यूज़र इंटरफ़ेस (यूआई) में रिपोर्ट किया गया मैसेज देखें.

गड़बड़ी के वैरिएबल

ये वैरिएबल तब सेट किए जाते हैं, जब यह नीति रनटाइम के दौरान कोई गड़बड़ी ट्रिगर करती है.

गड़बड़ी के रिस्पॉन्स का उदाहरण

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

गड़बड़ी के नियम का उदाहरण

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

मिलते-जुलते विषय

• OAuthV2 नीति
• OAuth होम
• टोकन कस्टमाइज़ करना और ऑथराइज़ेशन कोड