Расширение аутентификации Google

Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X. info

Версия: 2.0.1

Пройдите аутентификацию в Google для доступа к указанным вами API Google .

Используйте это расширение для получения токена (OAuth или JWT) для сервисов Google Cloud, а затем используйте токен для последующих вызовов API Google, например, с помощью политики ServiceCallout .

Например, в API-прокси вы можете получить токен с этим расширением, кэшировать токен с помощью политики PopulateCache , а затем передать токен через политику ServiceCallout для доступа к службам Google Cloud из потока API-прокси.

Предпосылки

Этот контент предоставляет справочную информацию по настройке и использованию этого расширения. Перед использованием расширения из API-прокси с помощью политики ExtensionCallout необходимо:

1. Убедитесь, что учетная запись, которую будет использовать расширение (учетная запись, представленная учетной записью службы, которую вы будете использовать для учетных данных), имеет доступ к службам Google Cloud, в которых расширение будет проходить аутентификацию.

2. Используйте Google Cloud Console для генерации ключа для учетной записи службы .

3. Используйте содержимое полученного JSON-файла ключа учетной записи службы при добавлении и настройке расширения с помощью ссылки на конфигурацию .

Об аутентификации с помощью Google Cloud

Это расширение запрашивает аутентификацию из Google Cloud, представляя определенного участника, определенного в вашем проекте Google Cloud . Вы используете файл JSON учетной записи службы этого участника проекта при настройке этого расширения.

В результате это расширение будет иметь доступ только к тем ресурсам, на которые у этого участника есть разрешение. Другими словами, успешная аутентификация этим расширением зависит от соответствия между разрешениями, предоставленными в Google Cloud Console, и доступом, запрошенным расширением (через области действия или аудиторию) во время выполнения.

Как правило, ваши шаги по аутентификации для доступа к API из этого расширения будут следующими:

1. Убедитесь, что учетная запись службы участника, которую представляет это расширение, имеет доступ к ресурсу Google, к которому вы хотите получить доступ. Вы можете использовать страницу Cloud Identity and Access Management (Cloud IAM) в Google Cloud Console, чтобы предоставить роли участнику проекта, которого представляет это расширение.

2. При настройке этого расширения используйте ключ учетной записи службы этого участника в формате JSON.

3. При настройке политики ExtensionCallout для использования этого расширения запрашивайте аутентификацию только для тех ресурсов, к которым имеет доступ ваш участник проекта.

Образцы

В следующих примерах показано, как выполнить аутентификацию в Google Cloud с использованием политики ExtensionCallout .

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

Действия

получитьOauth2AccessToken

Получает токен доступа OAuth 2.0. Используйте это действие для поддержки двухстороннего OAuth между вашим API-прокси и API Google, когда API Google требуют токен OAuth.

В двунаправленном OAuth это действие расширения извлекает токен OAuth, аутентифицируясь в Google с использованием JSON учетной записи службы (вы добавляете этот JSON при настройке этого расширения). После того, как это действие извлекает токен OAuth, ваш API-прокси может использовать токен для совершения вызовов API Google, фактически вызывая API от имени учетной записи службы Google.

Доступ к API Google Cloud фильтруется по областям, перечисленным в областях действия OAuth 2.0 для API Google .

Дополнительную информацию о взаимодействии серверов с OAuth 2.0 см. в разделе Использование OAuth 2.0 для приложений «сервер-сервер».

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

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

Параметры запроса

Ответ

Объект, содержащий токен доступа, его тип и дату истечения срока действия в следующей форме:

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

Свойства ответа

получитьJWTAccessToken

Получает токен доступа JSON web token (JWT). Вы можете использовать этот токен для аутентификации с помощью API Google, если API, который вы хотите вызвать, имеет определение службы, опубликованное в репозитории API Google GitHub .

С некоторыми API Google вы можете делать авторизованные вызовы API, используя подписанный JWT напрямую в качестве токена-носителя, а не токена доступа OAuth 2.0. Когда это возможно, вы можете избежать необходимости делать сетевой запрос на сервер авторизации Google перед выполнением вызова API.

Дополнительную информацию об аутентификации с помощью токена доступа JWT см. в разделе Использование OAuth 2.0 для межсерверных приложений .

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

Параметры запроса

Ответ

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

Свойства ответа

Ссылка на конфигурацию

Используйте следующее при настройке и развертывании этого расширения для использования в API-прокси. Действия по настройке расширения с помощью консоли Apigee см. в разделе Добавление и настройка расширения .

Общие свойства расширения

Следующие свойства присутствуют для каждого расширения.

Свойства этого пакета расширения

Укажите значения для следующих свойств конфигурации, специфичных для этого расширения.