Google Kimlik Doğrulama Uzantısı

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

Sürüm: 2.0.2

Belirttiğiniz Google API'lerine erişmek için Google ile kimliğinizi doğrulayın.

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

Örneğin, bir API proxy'sinde bu uzantıya sahip bir jeton alabilir, PopulateCache politikası ile jetonu önbelleğe alabilir, ardından ServiceCallout politikasını kullanarak jetonu ileterek bir API proxy akışından Google Cloud hizmetlerine erişebilirsiniz.

Ön koşullar

Bu içerik, uzantının yapılandırılması ve kullanılmasıyla ilgili referans bilgiler sağlar. ExtensionCallout politikası kullanılarak bir API proxy'sinden uzantıyı kullanmadan önce şunları yapmanız gerekir:

1. Uzantının kullanacağı hesabın (kimlik bilgileri için kullanacağınız hizmet hesabıyla temsil edilen hesap), uzantının kimliğini doğrulayacağı Google Cloud hizmetlerine erişimi olduğundan 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ı eklerken ve yapılandırırken sonuçta elde edilen hizmet hesabı anahtarı JSON dosyasının içeriğini kullanın.

Google Cloud ile kimlik doğrulama hakkında

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

Bu nedenle, uzantı yalnızca söz konusu üyenin izni olan kaynaklara erişebilir. Başka bir deyişle, bu uzantının başarılı bir şekilde kimlik doğrulaması yapması, Google Cloud Console'da verilen izinler ile uzantının çalışma zamanında istediği erişim (kapsamlar veya kitle aracılığıyla) arasındaki eşleşmeye bağlıdır.

Genel olarak, bu uzantıdan API'lere erişmek için kimlik doğrulama adımlarınız şunlar olacaktır:

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

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

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

Örnekler

Aşağıdaki örneklerde, ExtensionCallout politikası kullanılarak Google Cloud ile kimlik doğrulamanın nasıl 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 bir 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, hizmet hesabı JSON'u (bu uzantıyı yapılandırırken eklediğiniz JSON) kullanarak Google ile kimlik doğrulama 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 Google hizmet hesabı adına API'leri 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 üzerinden 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ınlanmış bir hizmet tanımı varsa bu jetonu kullanarak Google API'lerinde kimliğinizi doğrulayabilirsiniz.

Bazı Google API'lerinde, OAuth 2.0 erişim jetonu yerine doğrudan taşıyıcı jeton olarak imzalı bir JWT kullanarak yetkilendirilmiş 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ılacak şekilde yapılandırıp dağıtırken aşağıdakileri kullanın. Apigee konsolunu kullanarak uzantı yapılandırma adımları için Uzantı ekleme ve yapılandırma başlıklı makaleyi inceleyin.

Sık kullanılan uzantı özellikleri

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

Bu uzantı paketinin özellikleri

Bu uzantıya özel aşağıdaki yapılandırma özelliklerinin değerlerini belirtin.