OAuth 关联类型支持两种业界标准 OAuth 2.0 流程,即隐式和授权代码流程。
在隐式代码流程中,Google 会在用户浏览器中打开您的授权端点。成功登录后,系统会向 Google 返回长期访问令牌。现在,从 Google 助理向你的 Action 发送的每个请求中都包含此访问令牌。
在授权代码流程中,您需要两个端点:
- 授权端点,该端点负责向尚未登录的用户显示登录界面,并以短期授权代码的形式记录所请求的访问。
- 令牌交换端点,负责两种类型的交换:
- 将授权代码交换为长期刷新令牌和短期访问令牌。用户完成帐号关联流程后,系统会进行这种交换。
- 将长期刷新令牌换成短期访问令牌。Google 需要新访问令牌时,由于此令牌已过期,因此会进行此交换。
虽然隐式代码流程的实现更简单,但 Google 建议通过隐式流程发出的访问令牌永远不会过期,因为将令牌过期与隐式流程一起使用会强制用户再次关联其帐号。如果出于安全考虑需要令牌到期,强烈建议您考虑使用身份验证代码流程。
实现 OAuth 账号关联
配置项目
如需将项目配置为使用 OAuth 关联,请按以下步骤操作:
- 打开 Actions 控制台,然后选择要使用的项目。
- 点击开发标签页,然后选择账号关联。
- 启用账号关联旁边的开关。
- 在账号创建部分,选择否,我只想允许在我的网站上创建账号。
在关联类型中,选择 OAuth 和隐式。
在客户信息中:
- 为 Actions 发给 Google 的客户端 ID 赋值,以标识来自 Google 的请求。
- 插入授权端点和令牌交换端点的网址。
- 点击保存。
实现 OAuth 服务器
To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.
When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.
A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:
- Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
- Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
- Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.
Handle authorization requests
When your Action needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:
Authorization endpoint parameters | |
---|---|
client_id |
The client ID you assigned to Google. |
redirect_uri |
The URL to which you send the response to this request. |
state |
A bookkeeping value that is passed back to Google unchanged in the redirect URI. |
response_type |
The type of value to return in the response. For the OAuth 2.0 implicit
flow, the response type is always token . |
For example, if your authorization endpoint is available at https://myservice.example.com/auth
,
a request might look like:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
For your authorization endpoint to handle sign-in requests, do the following steps:
Verify the
client_id
andredirect_uri
values to prevent granting access to unintended or misconfigured client apps:- Confirm that the
client_id
matches the client ID you assigned to Google. - Confirm that the URL specified by the
redirect_uri
parameter has the following form: YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
- Confirm that the
Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.
Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.
Send an HTTP response that redirects the user's browser to the URL specified by the
redirect_uri
parameter. Include all of the following parameters in the URL fragment:access_token
: the access token you just generatedtoken_type
: the stringbearer
state
: the unmodified state value from the original request The following is an example of the resulting URL:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Google's OAuth 2.0 redirect handler will receive the access token and confirm
that the state
value hasn't changed. After Google has obtained an
access token for your service, Google will attach the token to subsequent calls
to your Action as part of the AppRequest.
为身份验证流程设计语音界面
检查用户是否已通过验证,并启动账号关联流程
- 在 Actions 控制台中打开您的 Actions Builder 项目。
- 创建新场景以在您的 Action 中启动账号关联:
- 点击场景。
- 点击添加 (+) 图标以添加新场景。
- 在新创建的场景中,点击条件的添加 add 图标。
- 添加一个条件,用于检查与对话关联的用户是否为已验证的用户。如果检查失败,您的 Action 将无法在对话期间执行账号关联,并且应回退到提供无需账号关联的功能。
- 在条件下的
Enter new expression
字段中,输入以下逻辑:user.verificationStatus != "VERIFIED"
- 在过渡下,选择不需要关联账号的场景,或选择仅限访客使用的功能的入口点场景。
- 在条件下的
- 点击条件对应的添加 add 图标。
- 添加一个条件,以便在用户没有关联身份时触发账号关联流程。
- 在条件下的
Enter new expression
字段中,输入以下逻辑:user.verificationStatus == "VERIFIED"
- 在过渡下,选择账号关联系统场景。
- 点击保存。
- 在条件下的
保存后,系统会在您的项目中添加一个名为 <SceneName>_AccountLinking
的新账号关联系统场景。
自定义账号关联场景
- 在场景下,选择账号关联系统场景。
- 点击发送提示,然后添加简短的句子,向用户说明该操作需要访问其身份信息的原因(例如“保存您的偏好设置”)。
- 点击保存。
- 在条件下,点击如果用户成功完成账号关联。
- 配置用户同意关联账号后,流程应如何继续。 例如,调用网络钩子来处理所需的任何自定义业务逻辑,然后转换回原始场景。
- 点击保存。
- 在条件下,点击如果用户取消或关闭账号关联。
- 配置用户不同意关联账号时流程应如何继续。例如,发送确认消息并重定向到提供不需要关联账号的功能的场景。
- 点击保存。
- 在条件下,点击如果发生系统或网络错误。
- 配置在因系统或网络错误而无法完成账号关联流程时,流程应如何继续。 例如,发送确认消息并重定向到提供不需要关联账号的功能的场景。
- 点击保存。
处理数据访问请求
如果辅助功能请求包含访问令牌,请先检查该访问令牌是否有效(未过期),然后从数据库中检索关联的用户账号。