身份验证和授权分别用于验证身份和访问资源的机制。本文档介绍了您在应用中实现身份验证和授权之前应了解的关键术语。
Authentication 可识别谁在发出请求。授权确定请求者可以访问哪些资源以及他们拥有的访问权限级别。身份验证是授权的前提条件。如果没有先确定请求者的身份,就无法确定要访问的资源。如需了解更详细的定义,请参阅重要术语部分。
请参考以下简化的酒店预订示例。当您到达酒店后,前台工作人员会要求您提供身份证件以验证您的预订。您的 ID 用于向酒店进行身份验证。前台店员会给你一把酒店房卡。您可以使用此密钥访问酒店的某些资源,例如酒店客房、健身房和商务中心。酒店键可授权您访问这些资源。
流程概览
下图显示了 Google Workspace API 的身份验证和授权的简要步骤:
![身份验证和授权实现概要步骤](https://developers.google.cn/workspace/images/auth-overview.png?authuser=6&hl=sr)
配置 Google Cloud 项目和应用:在开发过程中,在 Google Cloud 控制台中注册应用,定义授权范围和访问凭据,以使用 API 密钥、最终用户凭据或服务帐号凭据对应用进行身份验证。
对应用进行身份验证以授予访问权限:当您的应用运行时,系统会评估已注册的访问凭据。如果您的应用以最终用户身份进行身份验证,系统可能会显示登录提示。
请求资源:当您的应用需要访问 Google 资源时,它会请求 Google 使用您之前注册的相关访问权限范围。
征求用户同意:如果您的应用以最终用户的身份进行身份验证,Google 会显示 OAuth 权限请求页面,以便用户决定是否授予您的应用访问所请求数据的权限。
发送已批准的资源请求:如果用户同意访问范围,您的应用会将凭据和用户批准的访问范围捆绑到请求中。该请求会发送到 Google 授权服务器,以获取访问令牌。
Google 返回一个访问令牌:该访问令牌包含已授予的访问权限范围列表。如果返回的范围列表比所请求的访问权限范围更受限制,您的应用将停用受该令牌限制的所有功能。
访问请求的资源:您的应用使用 Google 提供的访问令牌调用相关 API 并访问资源。
获取刷新令牌(可选):如果您的应用需要在单个访问令牌的生命周期结束后访问 Google API,则可以获取刷新令牌。
请求更多资源:如果需要额外的访问权限,您的应用会要求用户授予新的访问权限范围,这会导致新的获取访问令牌的请求(第 3-6 步)。
重要术语
下表列出了与身份验证和授权相关的术语:
- 身份验证
确保主帐号(可以是用户或代表用户执行操作的应用)与其所宣称的身份相符。编写 Google Workspace 应用时,您应了解以下类型的身份验证:
- 用户身份验证
- 用户向您的应用进行身份验证(登录)的行为。用户身份验证通常通过登录流程执行。在这一过程中,用户使用用户名和密码组合来向应用验证自己的身份。使用 Google 帐号登录功能可以在应用中加入用户身份验证。
- 应用身份验证
- 应用代表运行应用的用户直接向 Google 服务进行身份验证。应用身份验证通常使用应用代码中预先创建的凭据执行。
- 授权
主帐号访问数据或执行操作所需的权限或“授权”。授权行为是通过您在应用中编写的代码执行的。此代码会通知用户应用希望代表他们执行操作,并在允许的情况下使用应用的唯一凭据从 Google 获取用于访问数据或执行操作的访问令牌。
- 凭据
软件安全中使用的一种标识形式。就身份验证而言,凭据通常是用户名和密码的组合。就 Google Workspace API 的授权而言,凭据通常是某种形式的标识,例如唯一的密钥字符串,仅在应用开发者和身份验证服务器之间已知。Google 支持以下身份验证凭据:API 密钥、OAuth 2.0 客户端 ID 和服务帐号。
- API 密钥
- 用于请求访问公开数据的凭据,例如使用 Maps API 提供的数据,或使用 Google Workspace 共享设置中的“互联网上的任何人知道此链接”设置共享的 Google Workspace 文件。
- OAuth 2 客户端 ID
- 用于请求访问用户拥有的数据的凭据。这是使用 Google Workspace API 请求访问数据时使用的主要凭据。此凭据需要用户同意。
- 客户端密钥
- 应只有应用和授权服务器知道的字符串。客户端密钥通过仅向已获授权的请求者授予令牌来保护用户的数据。切勿在应用中包含未加密的客户端密钥。我们建议您安全地存储客户端密钥。如需了解详情,请参阅安全地处理客户端凭据。
- 服务账号密钥
- 供服务帐号用于获得对 Google 服务的授权。
- 服务账号
- 用于服务器与服务器交互的凭据,例如作为访问某些数据或执行某些操作的进程运行的无人脸应用。服务帐号通常用于访问云端数据和操作。 但是,当与全网域授权功能结合使用时,这些权限可用于访问用户数据。
- 镜
OAuth 2.0 URI 字符串,用于定义对授予应用的资源或操作的访问权限级别。对于 Google Workspace,授权范围 URI 包含 Google Workspace 应用名称、应用访问的数据类型以及访问权限级别。应用的用户可以查看所请求的范围并选择要授予的访问权限,然后 Google 的身份验证服务器会通过访问令牌向您的应用返回允许的范围。如需了解详情,请参阅如何为应用选择范围。
- 授权服务器
Google 服务器,用于通过访问令牌向应用请求的数据和操作授予访问权限。
- 授权代码
从授权服务器发送的用于获取访问令牌的代码。只有当您的应用类型为 Web 服务器应用或已安装的应用时才需要代码。
- 访问令牌
授予对 Google Workspace API 的访问权限的令牌。单个访问令牌可授予对多个 API 的不同程度(称为“范围”)的访问权限。应用的授权代码会请求访问令牌,并使用这些访问令牌调用 Google Workspace API。
- 资源服务器
托管您的应用要调用的 API 的服务器。
- OAuth 2.0 框架
一种标准,可供您的应用代表应用用户为其提供“安全的委托访问权限”或对数据和操作的访问权限。您在应用中使用的身份验证和授权机制构成了 OAuth 2.0 框架的实现。
- 主账号
可被授予资源访问权限的实体。Google Workspace API 支持两种类型的主帐号:用户帐号和服务帐号。如需了解详情,请参阅主帐号。
- 数据类型
在身份验证和授权上下文中,数据类型是指拥有应用尝试访问的数据的实体。有三种数据类型:
- 公共领域数据
- 任何人都可以访问的数据,例如某些 Google 地图数据。此类数据通常使用 API 密钥进行访问。
- 最终用户数据
- 属于特定最终用户或群组的数据,例如特定用户的 Google 云端硬盘文件。此数据类型通常使用 OAuth 2 客户端 ID 或服务帐号进行访问。
- 云数据
- 由 Google Cloud 项目拥有的数据。此数据类型通常由服务帐号访问。
- 用户意见征求
一个授权步骤,需要应用用户授权应用访问数据和代表用户执行操作。
- 应用类型
您要创建的应用的类型。使用 Google Cloud 控制台创建凭据时,系统会要求您选择应用类型。应用类型包括:Web 应用 (JavaScript)、Android、Chrome 应用、iOS、电视和受限输入设备、桌面应用(也称为“已安装的应用”)和通用 Windows 平台 (UWP)。
- 服务账号
一种特殊类型的 Google 帐号,用于表示需要进行身份验证并获得授权才能访问数据的非人类用户。您的应用会使用服务帐号的身份来调用 Google API,这样用户就不必直接参与其中。服务帐号本身不能用于访问用户数据,而通常使用 Workspace API 来访问。不过,服务帐号可以通过实现全网域授权来访问用户数据。如需了解详情,请参阅了解服务帐号。
- 全网域授权
一项管理功能,可授权应用代表 Google Workspace 组织中的用户访问用户数据。全网域授权可用于对用户数据执行与管理员相关的任务。为以这种方式委派,Google Workspace 管理员可使用支持 OAuth 2.0 的服务帐号。此功能非常强大,只有超级用户才能启用全网域授权功能。如需了解详情,请参阅将全网域授权委派给服务帐号。
后续步骤
配置应用的 OAuth 权限请求页面,确保用户能够了解和批准您的应用对其数据拥有的访问权限。