Главная страница OAuth

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

Добро пожаловать на домашнюю страницу OAuth в Apigee Edge. На этой целевой странице представлены ссылки на документацию, примеры и другие ресурсы, связанные с использованием OAuth в Apigee Edge.

Платформа OAuth 2.0

Защитите свои API с помощью OAuth 2.0. В этом разделе перечислены ресурсы, примеры кода, видеоролики и другие темы, которые помогут вам успешно использовать OAuth 2.0 в Apigee Edge!

Узнайте об OAuth 2.0

Эта подборка ресурсов поможет вам освоить OAuth 2.0.

• Документация Apigee:
  • Введение в OAuth 2.0 . Охватывает основные концепции и термины OAuth 2.0. Фокусируется на использовании OAuth на Apigee Edge.
• Обучение и сертификаты Apigee:
  • Apigee предлагает онлайн-обучение для разработчиков API, включая курс по безопасности API , включающий OAuth.
• Спецификация IETF:
  • Спецификация IETF . Apigee настоятельно рекомендует вам ознакомиться с этой спецификацией. Он включает в себя хорошее базовое введение и концептуальный обзор.
• Электронная книга и видео Apigee:
  • OAuth the Big Picture — бесплатная электронная книга Apigee.
  • OAuth the Big Picture — бесплатная веб-трансляция Apigee.

Реализация потоков типа гранта

Apigee предоставляет рабочие примеры каждого типа гранта OAuth 2.0, которые помогут вам начать работу. Примеры представляют собой лучшие практики и демонстрируют, как реализовать типы грантов OAuth в Apigee Edge.

Учетные данные клиента

• Реализация типа предоставления учетных данных клиента — знакомит с типом предоставления с акцентом на действия, которые необходимо выполнить для реализации этого типа предоставления в Apigee Edge.
• Пример реализации . Ознакомьтесь с этим примером в нашем репозитории API-образцов на GitHub.
• Безопасность API (включая OAuth)

Код авторизации

• Реализация типа предоставления кода авторизации . Описывается тип разрешения с акцентом на действия, которые необходимо выполнить для реализации этого типа разрешения в Apigee Edge.
• Пример реализации . Ознакомьтесь с этим расширенным примером в нашем репозитории API-образцов на GitHub. Вы можете клонировать образец, развернуть его и запустить. Подробности смотрите в файле README . Он включает в себя надежное приложение для входа, которое аутентифицирует пользователей и безопасно взаимодействует с сервером авторизации.

Скрытый

• Запрос токенов: тип неявного предоставления — показывает, как запросить токены с типом неявного предоставления.

Учетные данные пароля владельца ресурса

• Реализация типа предоставления пароля . Описывается тип предоставления с акцентом на действия, которые необходимо выполнить для реализации этого типа предоставления в Apigee Edge.

Быстрые практические темы

В этих разделах вы найдете краткий контекст и краткие инструкции по выполнению распространенных задач OAuth 2.0:

• Настройка нового прокси API
• Регистрация клиентских приложений
• Получение учетных данных клиента
• Настройка конечных точек и политик OAuth
• Запрос токенов и кодов авторизации
• Настройка токенов доступа
• Утверждение и отзыв токенов доступа
• Отправка токена доступа
• Проверка токенов доступа
• Работа с областями действия
• Расширенные темы

Ссылки на политику и API

В этих разделах представлена ​​подробная справочная информация о политиках и API, которые напрямую поддерживают OAuth 2.0 в Edge.

• Политики OAuthV2 . Эти политики позволяют реализовать и настроить четыре типа разрешений OAuth 2.0 в Apigee Edge:
  • Политика OAuthV2 — основа реализации Apigee Edge OAuth 2.0. Он позволяет настраивать «операции» OAuth 2.0 в Apigee Edge, которые генерируют токены доступа и обновления, выдают коды авторизации и проверяют токены. В этом разделе приведены примеры кода, которые помогут проиллюстрировать, как все работает.
  • Политика GetOAuthV2Info — получает атрибуты токенов и делает их доступными для политик и кода, выполняющегося в прокси-сервере API. Этот тип политики может быть полезен, когда вам нужно настроить динамическое условное поведение на основе значения токена доступа. См. также Настройка токенов доступа .
  • Политика SetOAuthV2Info — обновляет профиль токена доступа. Например, вы можете встроить тег, уникальный для вашего бизнеса. См. также Настройка токенов доступа .
• Коды ошибок OAuth 2.0
  • Справочник по ответам об ошибках OAuth HTTP
• API OAuth 2.0 . Apigee предоставляет эти API для работы с конечными точками OAuth 2.0.
  • Токены доступа OAuth 2.0
  • Токены запроса OAuth 2.0
  • Токены обновления OAuth 2.0

Платформа OAuth 1.0a

OAuth 1.0a определяет стандартный протокол, который позволяет пользователям приложений разрешать приложениям использовать API от их имени, не требуя при этом от пользователей приложения раскрывать свои пароли приложению.

Справочник по политике OAuth 1.0a

В справочнике по политике OAuthV1 объясняется, как настроить политику OAuth v1.0a. Тип политики OAuthV1 отвечает за генерацию токенов запроса, генерацию токенов доступа и проверку токенов доступа на основе спецификации OAuth 1.0a.

API-интерфейсы OAuth 1.0a

Apigee предоставляет API для работы с конечными точками OAuth 1.0a.

• Токены доступа OAuth 1.0a
• Токены запроса OAuth 1.0a
• Верификаторы OAuth 1.0a

Образец OAuth 1.0a на GitHub

Этот пример прокси-сервера API на GitHub иллюстрирует трехстороннюю конфигурацию OAuth 1.0a. Вы можете скачать и запустить этот код.