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

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

Добро пожаловать на главную страницу 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: Общая картина — бесплатная электронная книга от 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
  • Справочник по ответам об ошибках HTTP OAuth
• 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. Вы можете скачать и запустить этот код.