Ekstensi Google Authentication

Mendapatkan token akses

Pada contoh berikut, tindakan getOauth2AccessToken ekstensi mengambil token untuk digunakan dalam permintaan ke 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>

Nilai respons akan terlihat seperti ini:

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

Kebijakan MenetapkanMessage berikut mengambil nilai respons dari kebijakan Extensioncallout di atas dan menyalinnya di payload respons. Hal ini dapat berguna untuk proses debug. Dalam praktik sebenarnya, Anda mungkin tidak ingin mengembalikan token ke klien.

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

Menyimpan token akses dalam cache

Guna menghindari panggilan yang tidak perlu untuk mengambil token, pertimbangkan untuk menyimpan token yang Anda terima ke dalam cache. Untuk panggilan mendatang yang memerlukan token, mengambil token dari cache Apigee Edge akan lebih cepat daripada mendapatkan token baru. Saat masa berlaku token yang di-cache berakhir, ambil token baru dan muat ulang cache dengan token tersebut.

Kode berikut dari contoh proxy API yang menggambarkan cara menetapkan dan menggunakan token yang di-cache untuk memanggil Google Translation API dengan kebijakan ServiceCallout. Setiap contoh kode di sini adalah untuk kebijakan yang berbeda dalam alur.

Kebijakan berikut dijalankan dalam urutan yang dijelaskan oleh XML alur berikut:

  <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. Kebijakan LookupCache berikut mencoba mendapatkan token dari cache. Jika token telah diperoleh dan di-cache, kebijakan ini akan mendapatkannya untuk digunakan oleh proxy API.

     <?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. Jika pencarian cache tidak mengambil token yang di-cache, kebijakan Extensioncallout berikut mengambil token OAuth baru, dengan menentukan Google Cloud Translation API sebagai cakupan untuk token tersebut. Google Cloud akan menampilkan token yang valid jika kredensial akun layanan yang digunakan saat mengonfigurasi ekstensi Google-Auth-Callout mewakili anggota project yang memiliki akses ke API.

     <?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. Setelah kebijakan ExtensionInfo mengambil token baru, kebijakan FillCache akan meng-cache-nya untuk digunakan nanti oleh kebijakan di proxy API.

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

Sintaksis

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

Contoh

Pada contoh berikut, tindakan getOauth2AccessToken ekstensi mengambil token untuk digunakan dalam permintaan ke Cloud Translation API.

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

Sintaksis

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

Contoh: URL Cloud Function

Pada contoh berikut, tindakan getOauth2AccessToken ekstensi mengambil token untuk digunakan dalam permintaan ke Cloud Translation API.

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

Contoh: Client ID yang diamankan Cloud IAP

Pada contoh berikut, tindakan getOauth2AccessToken ekstensi mengambil token untuk digunakan dalam permintaan ke Cloud Translation API.

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