Google ऑथेंटिकेशन एक्सटेंशन

ऐक्सेस टोकन पाना

नीचे दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, Cloud Translation API के अनुरोधों में इस्तेमाल करने के लिए टोकन को फिर से इकट्ठा करती है.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-Access-Token">
    <DisplayName>Get Access Token</DisplayName>
    <Connector>google-auth</Connector>
    <Action>getOauth2AccessToken</Action>
    <Input><![CDATA[{
      "scope" : [
        "https://www.googleapis.com/auth/cloud-translation"
      ]
    }]]></Input>
    <Output>google.credentials</Output>
</ConnectorCallout>

रिस्पॉन्स वैल्यू कुछ इस तरह दिखती है:

{
  "access_token":"ya29.c.ElpSB...BMgkALBJ0kou-8",
  "token_type":"Bearer",
  "expiresInSec": 3600
}

नीचे दी गई assignMessage नीति, ऊपर दी गई एक्सटेंशन कॉलआउट नीति से रिस्पॉन्स वैल्यू को फ़ेच करती है और उसे रिस्पॉन्स पेलोड में कॉपी करती है. यह डीबग करने में मददगार हो सकता है. असल में, हो सकता है कि आप क्लाइंट को टोकन वापस न करना चाहें.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Retrieve-Auth-Token">
    <DisplayName>Retrieve Auth Token</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{google.credentials.access_token}</Payload>
    </Set>
</AssignMessage>

ऐक्सेस टोकन को कैश मेमोरी में सेव करना

किसी टोकन को फिर से पाने के लिए बेवजह कॉल करने से बचने के लिए, आपको मिलने वाले टोकन को कैश मेमोरी में सेव करें. सबस्क्वेंट कॉल के लिए, टोकन की ज़रूरत होती है. ऐसे में, Apigee Edge की कैश मेमोरी से टोकन को नया टोकन पाने से ज़्यादा तेज़ी से वापस पाया जा सकता है. कैश मेमोरी में सेव किए गए टोकन की समयसीमा खत्म होने पर, नया टोकन फिर से पाएं और कैश मेमोरी को रीफ़्रेश करें.

उदाहरण के लिए API प्रॉक्सी का यह कोड बताता है कि ServiceCallout नीति के साथ Google Translation API को कॉल करने के लिए, कैश मेमोरी में सेव किए गए टोकन को कैसे सेट और इस्तेमाल किया जाता है. यहां दिया गया हर उदाहरण, फ़्लो में किसी अलग नीति के लिए है.

नीचे दी गई नीतियों को नीचे दिए गए फ़्लो एक्सएमएल में बताए गए क्रम में लागू किया जाता है:

  <Request>
    <!-- Attempt to get a token from the cache. -->
    <Step>
        <Name>Get-Cached-Auth-Token</Name>
    </Step>
    <!-- Only execute the following ExtensionCallout policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Google-Auth-Callout</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Only execute the following PopulateCache policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Cache-Auth-Token</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Use the ServiceCallout policy to call the translate API. -->
    <Step>
        <Name>Translate-Text</Name>
    </Step>
</Request>

1. नीचे दी गई lookupकैश नीति, कैश मेमोरी से टोकन पाने की कोशिश करती है. अगर टोकन पहले ही लिया जा चुका है और कैश मेमोरी में सेव किया जा चुका है, तो यह नीति उसे एपीआई प्रॉक्सी की मदद से इस्तेमाल करने के लिए मिलेगी.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <LookupCache async="false" continueOnError="false" enabled="true" name="Get-Cached-Auth-Token">
         <DisplayName>Get Cached Auth Token</DisplayName>
         <!-- Give cache key and scope to specify the entry for the cached token. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <!-- Assign the retrieved token (if any) to a variable, where it
          can be retrieved by policies. -->
         <AssignTo>cloud.translation.auth.token</AssignTo>
     </LookupCache>
   

2. अगर कैश लुकअप, कैश मेमोरी में सेव किए गए टोकन को वापस नहीं ला पाता है, तो नीचे दी गई एक्सटेंशन कॉलआउट नीति, नया OAuth टोकन वापस लाती है. इसमें Google Cloud Translation API को टोकन के स्कोप के तौर पर बताया जाता है. अगर Google-Auth-Callout एक्सटेंशन को कॉन्फ़िगर करते समय इस्तेमाल किए गए सेवा खाते के क्रेडेंशियल, प्रोजेक्ट के उस सदस्य को दिखाते हैं जिसके पास एपीआई का ऐक्सेस है, तो Google Cloud एक मान्य टोकन दिखाता है.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Google-Auth-Callout">
         <DisplayName>Google-Auth-Callout</DisplayName>
         <Connector>example-auth-extension</Connector>
         <Action>getOauth2AccessToken</Action>
         <Input><![CDATA[{
           "scope" : ["https://www.googleapis.com/auth/cloud-translation"]
         }]]></Input>
         <Output parsed="false">cloud.translation.auth.token</Output>
     </ConnectorCallout>
   

3. एक्सटेंशन कॉलआउट नीति से नया टोकन फ़ेच करने के बाद, पॉप्युलेट कैश पॉलिसी उसे कैश मेमोरी में सेव करती है, ताकि बाद में एपीआई प्रॉक्सी में मौजूद नीतियों के मुताबिक उसका इस्तेमाल किया जा सके.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <PopulateCache async="false" continueOnError="false" enabled="true" name="Cache-Auth-Token">
         <DisplayName>Cache Auth Token</DisplayName>
         <Properties/>
         <!-- Set cache key information to specify a unique key for this entry. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <ExpirySettings>
             <TimeoutInSec>5</TimeoutInSec>
         </ExpirySettings>
         <!-- Get the token to cache from the variable where the ExtensionCallout put it. -->
         <Source>cloud.translation.auth.token</Source>
     </PopulateCache>
   

सिंटैक्स

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
  "scope" : [
    "scope1",
    "scope2"
  ]
}]]></Input>

उदाहरण

नीचे दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, Cloud Translation API के अनुरोधों में इस्तेमाल करने के लिए टोकन को फिर से इकट्ठा करती है.

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
    "scope" : [
      "https://www.googleapis.com/auth/cloud-translation"
  ]
}]]></Input>

सिंटैक्स

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
    "audience" : "audience"
}]]></Input>

उदाहरण: Cloud फ़ंक्शन का यूआरएल

नीचे दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, Cloud Translation API के अनुरोधों में इस्तेमाल करने के लिए टोकन को फिर से इकट्ठा करती है.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/FUNCTION_NAME"
}]]></Input>

उदाहरण: Cloud IAP-सुरक्षित क्लाइंट आईडी

नीचे दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, Cloud Translation API के अनुरोधों में इस्तेमाल करने के लिए टोकन को फिर से इकट्ठा करती है.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "Cloud-IAP-secured-client-ID"
}]]></Input>