docs: 更新OIDC配置文档,新增use_raw_username、fetch_department_info、force_prompt_login配置说明

This commit is contained in:
Your Name 2026-04-16 15:01:49 +08:00
parent 174cf84cef
commit 392549f1ff

View File

@ -68,8 +68,36 @@ Yuxi 支持以OIDC接入第三方登录认证方便企业用户集成现有
# 姓名映射字段 (默认: name)
# OIDC_NAME_CLAIM=name
# 是否使用原始用户名(不带 oidc: 前缀),允许映射到 Yuxi 已有的本地账号 (true/false默认: false)
# 开启后OIDC 返回的 username 会直接作为 user_id 登录,需要管理员提前创建好用户账号
# OIDC_USE_RAW_USERNAME=false
# 是否从OIDC userinfo 中获取部门信息并自动创建关联部门 (true/false默认: false)
# OIDC_FETCH_DEPARTMENT_INFO=false
# 部门名称字段映射 (默认: department)
# OIDC_DEPARTMENT_CLAIM=department
# OIDC 登录时是否强制提示用户重新登录 (添加 prompt=login 参数true/false默认: false)
# OIDC_FORCE_PROMPT_LOGIN=false
```
### 3. 重启Yuxi服务使配置生效
```bash
docker restart api-dev web-dev
```
```
## 功能说明
### 使用原始用户名OIDC_USE_RAW_USERNAME=true
当你需要将 Yuxi 系统中已有的本地账号与 OIDC SSO 绑定,可以开启此选项。
**绑定原理**(无需修改数据库):
系统会创建一个标记为删除的占位用户 `oidc:{sub}:{target_user_id}` 来记录 OIDC sub 与 Yuxi 用户的绑定关系,确保只有绑定过的 OIDC 身份才能登录对应的账号,**防止账号冒用**。
### 自动获取部门信息OIDC_FETCH_DEPARTMENT_INFO=true
开启后,系统会从 OIDC userinfo 中读取部门名称和描述,自动在 Yuxi 中创建部门并将用户关联到该部门。
- 对从 OIDC 获取的部门名称会自动做 `strip()` 去空格,并截断到 50 字符
- 部门描述会自动截断到 255 字符
- 如果部门名称处理后为空,会回退到使用 `OIDC_DEFAULT_DEPARTMENT` 默认部门