GetOAuthV2Info नीति

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

क्या

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

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

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

सैंपल

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

<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 पर उपलब्ध हैं.

गड़बड़ी की जानकारी

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

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

Example fault rule

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

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

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