GetOAuthV2Info नीति

फ़िलहाल, Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं Apigee X दस्तावेज़. info

क्या

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

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

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

सैंपल

यहां दिए गए सैंपल में, OAuth2 वर्कफ़्लो के अलग-अलग कॉम्पोनेंट के बारे में जानकारी पाने के लिए, Get OAuth V2 Info नीति का इस्तेमाल किया गया है. इसके बाद, कोड में उस जानकारी को ऐक्सेस किया गया है.

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

<AccessToken> एलिमेंट

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

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

<AuthorizationCode> एलिमेंट

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

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

<ClientId> एलिमेंट

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

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

<IgnoreAccessTokenStatus> एलिमेंट

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

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

<RefreshToken> एलिमेंट

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

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

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

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

क्लाइंट आईडी वैरिएबल

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 होम
• टोकन और ऑथराइज़ेशन कोड को पसंद के मुताबिक बनाना