File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -68,8 +68,36 @@ Yuxi 支持以OIDC接入第三方登录认证,方便企业用户集成现有
6868# 姓名映射字段 (默认: name)
6969# OIDC_NAME_CLAIM=name
7070
71+ # 是否使用原始用户名(不带 oidc: 前缀),允许映射到 Yuxi 已有的本地账号 (true/false,默认: false)
72+ # 开启后,OIDC 返回的 username 会直接作为 user_id 登录,需要管理员提前创建好用户账号
73+ # OIDC_USE_RAW_USERNAME=false
74+
75+ # 是否从OIDC userinfo 中获取部门信息并自动创建关联部门 (true/false,默认: false)
76+ # OIDC_FETCH_DEPARTMENT_INFO=false
77+
78+ # 部门名称字段映射 (默认: department)
79+ # OIDC_DEPARTMENT_CLAIM=department
80+
81+ # OIDC 登录时是否强制提示用户重新登录 (添加 prompt=login 参数,true/false,默认: false)
82+ # OIDC_FORCE_PROMPT_LOGIN=false
83+
7184```
7285### 3. 重启Yuxi服务使配置生效
7386``` bash
7487docker restart api-dev web-dev
75- ```
88+ ```
89+
90+ ## 功能说明
91+
92+ ### 使用原始用户名(OIDC_USE_RAW_USERNAME=true)
93+ 当你需要将 Yuxi 系统中已有的本地账号与 OIDC SSO 绑定,可以开启此选项。
94+
95+ ** 绑定原理** (无需修改数据库):
96+ 系统会创建一个标记为删除的占位用户 ` oidc:{sub}:{target_user_id} ` 来记录 OIDC sub 与 Yuxi 用户的绑定关系,确保只有绑定过的 OIDC 身份才能登录对应的账号,** 防止账号冒用** 。
97+
98+ ### 自动获取部门信息(OIDC_FETCH_DEPARTMENT_INFO=true)
99+ 开启后,系统会从 OIDC userinfo 中读取部门名称和描述,自动在 Yuxi 中创建部门并将用户关联到该部门。
100+
101+ - 对从 OIDC 获取的部门名称会自动做 ` strip() ` 去空格,并截断到 50 字符
102+ - 部门描述会自动截断到 255 字符
103+ - 如果部门名称处理后为空,会回退到使用 ` OIDC_DEFAULT_DEPARTMENT ` 默认部门
You can’t perform that action at this time.
0 commit comments