核心操作流程

进入 OAuth 配置页面

  • 登录管理控制台。
  • 左侧导航栏点击「系统设置」，进入系统配置页面。
  • 在配置页面中找到「自定义 OAuth 提供商」模块，点击「添加 OAuth 提供商」按钮，弹出配置弹窗。

核心凭证配置

配置项 填写规则 示例
Client ID* 从 OAuth 提供商平台获取的客户端唯一标识 Iv1.xxxxxxxxxxxxxxxx
Client Secret* 从 OAuth 提供商平台获取的客户端密钥，严格保密，禁止泄露 GOCSPX-xxxxxxxxxxxxxxxxxxxx

OAuth 端点配置

配置项 填写规则 示例
授权端点 * OAuth 提供商授权接口地址，用于发起授权请求 https://gitlab.example.com/oauth/authorize
令牌端点 * 用于兑换访问令牌的接口地址 https://gitlab.example.com/oauth/token
用户信息端点 * 用于获取授权用户基本信息的接口地址 https://gitlab.example.com/api/user

权限范围配置

Scopes（可选）：授权权限范围，多个 scope 用空格分隔，遵循 OAuth 提供商规范。
通用基础配置：openid profile email
自定义配置：根据提供商需求补充（如 GitHub 的repo、GitLab 的read_user）

启用配置

配置完成后，可选择开启「启用供应商」开关，配置保存后立即生效；若暂不启用，可保持关闭状态。
点击「保存」按钮，完成 OAuth 提供商新增。

字段映射配置说明

用于配置系统如何从 OAuth 用户信息 API 的响应中，提取并映射为系统所需的用户数据，支持 JSONPath 语法，实现灵活的字段适配。

配置项 作用 示例值 说明
用户 ID 字段（可选） 用于唯一标识用户的字段路径，是 OAuth 账号与系统用户绑定的核心依据 sub 绝大多数标准 OAuth 服务会返回sub字段作为用户唯一标识，建议优先使用此字段
用户名字段（可选） 映射 OAuth 返回的用户名 / 账号字段 admin 可根据实际响应字段调整，如login、username、account等
显示名字段（可选） 映射 OAuth 返回的用户昵称 / 显示名称字段 username 可替换为name、nickname等，作为系统内用户的展示名称
邮箱字段（可选） 映射 OAuth 返回的用户邮箱字段 email 需确保 OAuth 服务已授权email scope，否则可能返回空值

{
  "sub": "12345678",
  "login": "zhangsan",
  "name": "张三",
  "email": "zhangsan@example.com",
  "profile": {
    "nickname": "小张"
  }
}
配置项 填写值 说明
用户 ID 字段 sub 直接取根节点的sub值
用户名字段 login 取根节点的login值
显示名字段 $.profile.nickname 使用 JSONPath 语法取嵌套节点的昵称
邮箱字段 email 取根节点的email值

参考

https://github.com/QuantumNous/new-api/issues/3334