本页面适用于 Apigee 和 Apigee Hybrid。
查看 Apigee Edge 文档。
欢迎访问 Apigee 的 OAuth 2.0 功能的首页。此着陆页提供了有关在 Apigee 上使用 OAuth 2.0 的文档、示例和其他资源链接。
OAuth 2.0 框架
使用 OAuth 2.0 保护您的 API。本部分列出了相关资源、示例代码、视频和其他主题，帮助您在 Apigee 上成功使用 OAuth 2.0。
了解 OAuth 2.0
这些资源有助于您快速上手 OAuth 2.0。
-
Apigee 文档：
- OAuth 2.0 简介 -- 涵盖基本的 OAuth 2.0 概念和术语。侧重于在 Apigee 上使用 OAuth 2.0。
- Apigee 培训和认证：
- Apigee 为 API 开发者提供在线培训，包括 API 安全课程，其中涵盖 OAuth 2.0。
-
IETF 规范：
- IETF 规范 -- Apigee 强烈建议您查看此规范。该规范包括出色的简要介绍和概念概览。
-
Apigee 电子书：
- 《OAuth：概览》，一款免费的 Apigee 电子书。
实现授权类型流程
以下主题介绍了如何在 Apigee 上实现 OAuth 2.0 授权类型：
- 实现客户端凭据授权类型 - 介绍授权类型，并着重介绍您在 Apigee 上实现此授权类型时需要遵循的步骤。
- 实现授权代码授权类型 - 介绍授权类型，并着重介绍您在 Apigee 上实现此授权类型时需要遵循的步骤。
- 使用隐式授权类型 - 演示如何请求授权类型为隐式的令牌。
- 实现密码授权类型 - 介绍授权类型，并重点介绍在 Apigee 上实现此授权类型时需要遵循的步骤。
方法主题
这些主题介绍了如何在 Apigee 中处理常见的 OAuth 2.0 任务：
- OAuth 2.0：配置新的 API 代理
- 注册客户端应用
- 获取客户端凭据
- 了解 OAuth 端点
- 获取 OAuth 2.0 令牌
- 自定义令牌和授权代码
- 撤消和批准令牌
- 发送访问令牌
- 验证访问令牌
- 使用 OAuth 2.0 范围
- 高级 OAuth 2.0 主题
- 使用 JWT OAuth 2.0 令牌
OAuth 2.0 政策
这些政策使您可在 Apigee API 代理中执行 OAuth 2.0 操作：
- OAuthV2 政策：实现 Apigee OAuth 2.0 的核心。它允许您在 Apigee 上配置 OAuth 2.0“操作”，以生成访问和刷新令牌、发出授权代码并验证令牌。本主题包含的代码示例可帮助您理解代码运作的原理。
- GetOAuthV2Info 政策：获取令牌的属性，并将这些属性提供给 API 代理中执行的政策和代码。当您需要根据访问令牌中的值配置有条件的动态行为时，此政策类型非常有用。另请参阅自定义访问令牌。
- SetOAuthV2Info 政策：更新访问令牌的配置文件。例如，您可能需要嵌入您的企业独有的标记。另请参阅自定义访问令牌。