Вы просматриваете документацию по 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: общая картина – бесплатная трансляция Apigee.
Как реализовать потоки для разных типов грантов
Apigee предоставляет рабочие примеры для каждого типа авторизации OAuth 2.0, чтобы помочь вам начать работу. Примеры представляют собой рекомендации и показывают, как реализовать типы предоставления OAuth в Apigee Edge.
Учетные данные клиента
- Реализация типа предоставления учетных данных клиента – описание типа предоставления с акцентом на шагах, которые необходимо выполнить, чтобы реализовать этот тип предоставления в Apigee Edge.
- Пример реализации. Ознакомьтесь с примером в нашем репозитории api-samples на GitHub.
- Безопасность API (включая OAuth)
Код авторизации
- Реализация типа предоставления доступа с кодом авторизации. В этом разделе рассказывается о типе предоставления доступа и о том, как реализовать его в Apigee Edge.
- Пример реализации – ознакомьтесь с этим сложным примером в нашем репозитории api-samples на GitHub. Вы можете клонировать, развернуть и запустить образец. Подробнее о файле README… В него входит надежное приложение для входа, которое аутентифицирует пользователей и безопасно взаимодействует с сервером авторизации.
Неявный
- Запрос токенов: неявный тип предоставления разрешения – как запрашивать токены с неявным типом предоставления разрешения.
Учетные данные владельца ресурса
- Реализация типа предоставления доступа с использованием пароля – описание типа предоставления доступа с акцентом на шаги, которые необходимо выполнить, чтобы реализовать этот тип предоставления доступа в Apigee Edge.
Краткие инструкции
В этих разделах вы найдете краткую информацию и пошаговые инструкции по выполнению распространенных задач OAuth 2.0:
- Настройка нового прокси-сервера API
- Регистрация клиентских приложений
- Получение учетных данных клиента
- Настройка конечных точек и правил OAuth
- Как запросить токены и коды авторизации
- Настройка токенов доступа
- Как одобрять и отзывать токены доступа
- Отправка токена доступа
- Как подтверждать токены доступа
- Работа с областями действия
- Дополнительные темы
Правила и справочная информация об API
В этих разделах приведена подробная справочная информация о правилах и API, которые напрямую поддерживают OAuth 2.0 в Edge.
-
Правила OAuthV2. Эти правила позволяют реализовать и настроить четыре типа разрешений OAuth 2.0 в Apigee Edge:
- Правило OAuthV2 – основа реализации OAuth 2.0 в Apigee Edge. Он позволяет настраивать "операции" OAuth 2.0 в Apigee Edge, которые генерируют токены доступа и обновления, выдают коды авторизации и проверяют токены. В этой теме приведены примеры кода, которые помогут вам понять, как все работает.
- Правило GetOAuthV2Info позволяет получать атрибуты токенов и делать их доступными для правил и кода, выполняемого в прокси-сервере API. Этот тип правил может быть полезен, когда вам нужно настроить динамическое условное поведение на основе значения в токене доступа. Также ознакомьтесь с информацией о том, как настроить токены доступа.
- Правило SetOAuthV2Info позволяет обновить профиль токена доступа. Например, вы можете захотеть добавить тег, который уникален для вашей компании. Также ознакомьтесь с информацией о том, как настроить токены доступа.
- Коды ошибок OAuth 2.0
- API OAuth 2.0 – Apigee предоставляет эти API для работы с конечными точками OAuth 2.0.
Структура OAuth 1.0a
OAuth 1.0a – это стандартный протокол, который позволяет пользователям предоставлять приложениям доступ к API от их имени, не раскрывая при этом пароли.
Справочник по правилам OAuth 1.0a
Поддержка OAuth 1.0a прекращена. Подробнее об устаревших функциях… Правило OAuthV1 отвечает за создание токенов запроса и доступа, а также за проверку токенов доступа на основе спецификации OAuth 1.0a.
API OAuth 1.0a
Apigee предоставляет API для работы с конечными точками OAuth 1.0a.
Пример OAuth 1.0a на GitHub
В примере прокси-сервера API на GitHub показана трехсторонняя конфигурация OAuth 1.0a. Вы можете скачать и запустить этот код.
| Название | Описание |
|---|---|
| oauth10a-3legged | Показывает трехстороннюю конфигурацию OAuth 1.0a. |