nocobase/packages/plugins/oidc/README.zh-CN.md
2023-06-19 21:32:16 +08:00

1.6 KiB
Raw Blame History

OIDC

提供标准Open ConnectID接入登录功能。
本插件登录流程使用授权码模式 (Authorization Code Flow).

依赖

  • @nocobase/plugin-auth 提供表,模型函数复用等

使用方法

以Sign in with Google为例
https://developers.google.com/identity/openid-connect/openid-connect

获取Google OAuth 2.0凭据

Google Cloud控制台 - 创建凭据 - OAuth客户端ID

进入到配置界面,填写授权重定向URL. 重定向URL可以在Nocobase新增认证器时获取通常情况下为http(s)://host:port/api/oidc:redirect.

完成后复制客户端ID客户端密钥

在NocoBase上新增认证器

插件设置 - 认证 - 新增 - OIDC

依次填写
  • Issuer - issuer由IdP提供通常以/.well-known/openid-configuration结尾Google的为https://accounts.google.com/.well-known/openid-configuration
  • Client ID - 客户端ID
  • Client Secret - 客户端密钥
  • scope - 选填默认为openid email profile
  • id_token signed response algorithm - id_token的签名方法默认为RS256
  • HTTP - 回调地址是否为http协议默认https
  • Port - 回调地址端口默认为443/80
  • Field Map - 如果需要将用户相关字段映射可以在这里配置默认昵称为openid.

在有email的情况下登录时将尝试匹配已有用户否则创建新用户。