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

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

Версия: 1.0.2

Пройдите аутентификацию в 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>

Действия

getOauth2AccessToken

Получает токен доступа 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
}

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

получитьJWTAAccessToken

Получает токен доступа веб-токена JSON (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 см. в разделе Добавление и настройка расширения .

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

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

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

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