OAuth 首页

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息

欢迎访问位于 Apigee Edge 上的 OAuth 首页。此着陆页提供了有关在 Apigee Edge 上使用 OAuth 的文档、示例和其他资源链接。

OAuth 2.0 框架

使用 OAuth 2.0 保护您的 API。本部分列出了相关资源、示例代码、视频和其他主题，帮助您在 Apigee Edge 上成功使用 OAuth 2.0！

了解 OAuth 2.0

这些资源有助于您快速上手 OAuth 2.0。

  • Apigee 文档：
    • OAuth 2.0 简介 -- 涵盖基本的 OAuth 2.0 概念和术语。重点讲述在 Apigee Edge 上使用 OAuth。
  • Apigee 培训和认证：
    • Apigee 为 API 开发者提供在线培训，包括 API 安全课程，其中涵盖 OAuth。
  • IETF 规范：
    • IETF 规范 -- Apigee 强烈建议您查看此规范。该规范包括出色的简要介绍和概念概览。
  • Apigee 电子书和视频：

实现授权类型流程

Apigee 提供了各种 OAuth 2.0 授权类型的有效示例，帮助您入门。这些示例均为最佳做法，并且演示了如何在 Apigee Edge 上实现 OAuth 授权类型。

客户端凭据

授权代码

  • 实现授权代码授权类型 -- 介绍授权类型，并着重介绍您在 Apigee Edge 上实现此授权类型需要遵循的步骤。
  • 示例实现 -- 在 GitHub 上的 api-samples 代码库中查看此高级示例。您可以克隆、部署和运行该示例。有关详情，请参阅 README 文件。该示例包含强大的登录应用，能够对用户进行身份验证并与授权服务器安全通信。

隐式

资源所有者密码凭据

  • 实现密码授权类型 -- 介绍授权类型，并着重介绍您在 Apigee Edge 上实现此授权类型需要遵循的步骤。

快速操作方法主题

以下主题为您提供了快速的上下文和简明的步骤，以便处理常见 OAuth 2.0 任务：

政策和 API 参考文档

这些主题针对直接在 Edge 上支持 OAuth 2.0 的政策和 API 提供了详细参考信息。

  • OAuthV2 政策 -- 这些政策可让您在 Apigee Edge 上实现和自定义四种 OAuth 2.0 授权类型：
    • OAuthV2 政策 -- 实现 Apigee Edge OAuth 2.0 的核心。它允许您在 Apigee Edge 上配置 OAuth 2.0“操作”，以生成访问和刷新令牌、发出授权代码并验证令牌。本主题包含的代码示例可帮助您理解代码运作的原理。
    • GetOAuthV2Info 政策 -- 获取令牌的属性，并将这些属性提供给 API 代理中执行的政策和代码。当您需要根据访问令牌中的值配置有条件的动态行为时，此政策类型非常有用。另请参阅自定义访问令牌。
    • SetOAuthV2Info 政策 -- 更新访问令牌的配置文件。例如，您可能希望嵌入一个贵公司独有的代码。另请参阅自定义访问令牌。
  • OAuth 2.0 错误代码
  • OAuth 2.0 API -- Apigee 提供了这些 API，以与 OAuth 2.0 端点配合使用。

OAuth 1.0a 框架

OAuth 1.0a 定义了一个标准协议，使应用用户能够授权应用以其名义使用 API，无需应用用户在使用过程中将密码透露给应用。

OAuth 1.0a 政策参考文档

对 OAuth 1.0a 的支持已弃用。如需了解详情，请参阅已弃用的功能。OAuthV1 政策类型负责根据 OAuth 1.0a 规范生成请求令牌、生成访问令牌和验证访问令牌。

OAuth 1.0a API

Apigee 提供 API，以便与 OAuth 1.0a 端点搭配使用。

GitHub 上的 OAuth 1.0a 示例

GitHub 上的示例 API 代理展示了三足式 OAuth 1.0a 配置。您可以下载并运行此代码。

姓名 说明
oauth10a-3legged 演示了三足式 OAuth 1.0a 配置。