Google Kimlik Doğrulama Uzantısı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Sürüm: 2.0.0

Belirttiğiniz Google API'lerine erişim için Google ile kimlik doğrulama yapın.

Google Cloud hizmetleri için jeton (OAuth veya JWT) almak üzere bu uzantıyı kullanın, ardından jetonu Google API'ye yapılan sonraki çağrılar için kullanın (ör. ServiceCallout politikası kullanarak).

Örneğin, bir API proxy'sinde bu uzantıya sahip bir jeton alabilir, PopulateCache politikasını kullanarak jetonu önbelleğe alabilir ve ardından API proxy akışı içinden Google Cloud hizmetlerine erişmek için jetonu ServiceCallout politikası üzerinden iletebilirsiniz.

Ön koşullar

Bu içerikte, bu uzantıyı yapılandırma ve kullanmayla ilgili referanslar sağlanmaktadır. ExtensionCallout politikasını kullanarak uzantıyı bir API proxy'sinden kullanmadan önce şunları yapmanız gerekir:

1. Uzantı tarafından kullanılacak hesabın (kimlik bilgileri için kullanacağınız hizmet hesabı tarafından temsil edilen hesap), uzantının kimlik doğrulayacağı Google Cloud hizmetlerine erişebildiğinden emin olun.

2. Hizmet hesabı için anahtar oluşturmak üzere Google Cloud Console'u kullanın.

3. Yapılandırma referansını kullanarak uzantıyı ekleme ve yapılandırma sırasında elde edilen hizmet hesabı anahtarı JSON dosyasının içeriğini kullanın.

Google Cloud ile kimlik doğrulama hakkında

Bu uzantı, Google Cloud projenizde tanımlanmış belirli bir üyeyi temsil ederek Google Cloud'dan kimlik doğrulaması ister. Bu uzantıyı yapılandırırken söz konusu proje üyesinin hizmet hesabı JSON dosyasını kullanırsınız.

Sonuç olarak bu uzantı, yalnızca söz konusu üyenin izni olan kaynaklara erişebilir. Diğer bir deyişle, bu uzantı tarafından başarılı bir kimlik doğrulamasının yapılması, Google Cloud Console'da verilen izinler ile çalışma zamanında uzantı tarafından istenen erişim (kapsamlar veya kitle aracılığıyla) arasında bir eşleşmeye bağlıdır.

Genel olarak, bu uzantıdan API'lere erişim için kimlik doğrulama adımları aşağıdaki gibidir:

1. Bu uzantının temsil ettiği üye hizmet hesabının, erişmek istediğiniz Google kaynağına erişebildiğinden emin olun. Bu uzantının temsil ettiği proje üyesine rol atamak için Google Cloud Console'daki Cloud Identity and Access Management (Cloud IAM) sayfasını kullanabilirsiniz.

2. Bu uzantıyı yapılandırırken ilgili üyenin hizmet hesabı anahtarı JSON'unu kullanın.

3. Bu uzantıyı kullanacak bir ExtensionCallout politikası yapılandırırken yalnızca proje üyenizin erişebildiği kaynaklar için kimlik doğrulama isteyin.

Örnekler

Aşağıdaki örneklerde, ExtensionCallout politikası kullanılarak Google Cloud ile nasıl kimlik doğrulaması yapılacağı gösterilmektedir.

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

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

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

İşlemler

getOauth2AccessToken

OAuth 2.0 erişim jetonu alır. Google API'leri OAuth jetonu gerektirdiğinde API proxy'niz ile Google API'leri arasında iki ayaklı OAuth'u desteklemek için bu işlemi kullanın.

İki aşamalı OAuth'ta bu uzantı işlemi, bir hizmet hesabı JSON'u (bu uzantıyı yapılandırırken eklediğiniz JSON) kullanarak Google ile kimlik doğrulaması yaparak bir OAuth jetonu alır. Bu işlem OAuth jetonunu aldıktan sonra API proxy'niz, Google API'lerine çağrı yapmak için jetonu kullanabilir ve API'leri Google hizmet hesabı adına etkili bir şekilde çağırabilir.

Google Cloud API'lerine erişim, Google API'leri için OAuth 2.0 kapsamları bölümünde listelenen kapsamlar aracılığıyla filtrelenir.

OAuth 2.0 ile sunucudan sunucuya etkileşimler hakkında daha fazla bilgi için Sunucudan Sunucuya Uygulamalar için OAuth 2.0'ı Kullanma başlıklı makaleyi inceleyin.

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

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

İstek parametreleri

Yanıt

Erişim jetonunu, türünü ve geçerlilik bitiş tarihini aşağıdaki biçimde içeren bir nesne:

{
  "accessToken": "ewogICJ0eXB...C5jb20iCn0K",
  "token_type": "Bearer",
  "expiresInSec": 3600
}

Yanıt özellikleri

getJWTAccessToken

JSON web jetonu (JWT) erişim jetonu alır. Çağırmak istediğiniz API'nin Google API'leri GitHub deposunda yayınlanan bir hizmet tanımı varsa bu jetonu Google API'leriyle kimlik doğrulama yapmak için kullanabilirsiniz.

Bazı Google API'lerinde, OAuth 2.0 erişim jetonu yerine doğrudan taşıyıcı jetonu olarak imzalanmış bir JWT kullanarak yetkili API çağrıları yapabilirsiniz. Bu mümkün olduğunda, API çağrısı yapmadan önce Google'ın yetkilendirme sunucusuna ağ isteği göndermeniz gerekmez.

JWT erişim jetonuyla kimlik doğrulama hakkında daha fazla bilgi için Sunucudan Sunucuya Uygulamalar için OAuth 2.0'ı Kullanma başlıklı makaleyi inceleyin.

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

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

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

İstek parametreleri

Yanıt

{
  "accessToken": "token",
  "tokenType": "Bearer",
  "expiresInSec": 3600
}

Yanıt özellikleri

Yapılandırma referansı

Bu uzantıyı API proxy'lerinde kullanılmak üzere yapılandırırken ve dağıtırken aşağıdakileri kullanın. Apigee konsolunu kullanarak bir uzantıyı yapılandırma adımları için Uzantı ekleme ve yapılandırma başlıklı makaleyi inceleyin.

Ortak uzantı özellikleri

Aşağıdaki özellikler her uzantı için mevcuttur.

Bu uzantı paketine ait özellikler

Bu uzantıya özgü aşağıdaki yapılandırma özellikleri için değerler belirtin.