0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-01-20 21:32:31 -05:00

docs(connector): google connector zh-cn (#1540)

This commit is contained in:
Xiao Yijun 2022-07-14 14:27:17 +08:00 committed by GitHub
parent f72319f234
commit 9bdd80ebcc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,33 @@
# Google
# Google connector
The Google connector provides a succinct way for your application to use Googles OAuth 2.0 authentication system.
Google 连接器为你的应用程序提供了一种接入 Google OAuth 2.0 身份验证系统的简单方式。
**Table of contents**
- [Google connector](#google-connector)
- [Set up a project in the Google API Console](#set-up-a-project-in-the-google-api-console)
- [Configure your consent screen](#configure-your-consent-screen)
- [Configure and register your application](#configure-and-register-your-application)
- [Edit app registration](#edit-app-registration)
- [Config OAuth consent screen](#config-oauth-consent-screen)
- [Config scopes](#config-scopes)
- [Add test users (External user type only)](#add-test-users-external-user-type-only)
- [Obtain OAuth 2.0 credentials](#obtain-oauth-20-credentials)
- [Config types](#config-types)
- [References](#references)
- [Google 连接器](#google-连接器)
- [在 Google API 控制台中创建一个项目](#在-google-api-控制台中创建一个项目)
- [配置 OAuth 同意屏幕](#配置-oauth-同意屏幕)
- [注册和配置应用](#注册和配置应用)
- [修改应用注册](#修改应用注册)
- [设置「OAuth 同意屏幕」](#设置oauth-同意屏幕)
- [配置权限「范围」](#配置权限范围)
- [添加「测试用户」仅「User Type」用户类型设置为「外部」时需要](#添加测试用户仅user-type用户类型设置为外部时需要)
- [获取 OAuth 2.0 凭据](#获取-oauth-20-凭据)
- [配置类型](#配置类型)
- [参考](#参考)
## Set up a project in the Google API Console
- Visit the [Google API Console](https://console.developers.google.com) and sign in with your Google account.
@ -56,3 +82,60 @@ Now you should have the Google OAuth 2.0 consent screen configured.
## References
* [Google Identity: Setting up OAuth 2.0](https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup)
# Google 连接器
## 在 Google API 控制台中创建一个项目
- 用你的 Google 帐号登录 [Google 云端平台](https://console.developers.google.com)。
- 点按顶部菜单栏上的「选择项目」,然后点击「新建项目」按钮,新建一个项目。
- 在新创建的项目中点击「API 和服务」进入「API 和服务」的页面中。
## 配置 OAuth 同意屏幕
### 注册和配置应用
- 在左侧的「API 和服务」的菜单栏中, 点按「OAuth 同意屏幕」。
- 选择你所需要的「User Type」用户类型之后点击「创建」。注意: 如果你将「User Type」用户类型设置为「外部」在后续的步骤中你需要设置测试用户。
现在你将位于「修改应用注册」页面。
### 修改应用注册
#### 设置「OAuth 同意屏幕」
- 根据页面提示填写「OAuth 同意屏幕」相关表单。
- 点按「保存并继续」以进行后续操作。
#### 配置权限「范围」
- 点击「添加或移除范围」按钮,然后在弹出的抽屉页面中选择 `../auth/userinfo.email``../auth/userinfo.profile``openid`,然后点击「更新」以完成配置。
- 根据你的需求填写页面上的相关的表单。
- 点按「保存并继续」以进行后续操作。
#### 添加「测试用户」仅「User Type」用户类型设置为「外部」时需要
- 点击 「+ ADD USERS」添加用户添加测试用户以便这些用户能在应用的发布状态为”测试时“能访问该应用。
- 点按「保存并继续」以进行后续操作。
现在你已经配置好了 Google 的「OAuth 同意屏幕」。
## 获取 OAuth 2.0 凭据
- 在左侧「API 和服务」的菜单中,点按「凭据」选项。
- 在「凭据」页面内的上部菜单栏中,点击「+ 创建凭据」然后选择「OAuth 客户端 ID」。
- 在「创建 OAuth 客户端 ID」页面内将「应用类型」设置为「Web 应用」。
- 填写相关的应用基本信息。
- 在「已获授权的 JavaScript 来源」中,点击「+ 添加URI」该 URI 值为你所部署的 Logto 服务的地址。此处这个值应为 `${your_logto_origin}`。例如:`https://logto.dev`
- 在「已获授权的重定向 URI」中点击「+ 添加URI」以添加「已获授权的重定向 URI」。「已获授权的重定向 URI」将在用户使用 Google 帐号成功登录 Logto 后将用户重定向回你的应用。此处这个值应为 `${your_logto_origin}/callback/google-universal`。例如:`https://logto.dev/callback/google-universal`
- 点击「创建」后,你将获得「客户端 ID」Client ID和「客户端密钥」Client Secret
### 配置类型
| 名称 | 类型 |
|:------------:|:------:|
| clientId | string |
| clientSecret | string |
## 参考
* [Google Identity: 设置 OAuth 2.0](https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup)