Skip to content

Commit

Permalink
ldap auto register (#2513)
Browse files Browse the repository at this point in the history
  • Loading branch information
cooper-lzy authored Feb 2, 2023
1 parent 5d88782 commit edcf907
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs-2.0/nebula-dashboard-ent/5.account-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ Dashboard 企业版支持用户自行创建本地账号。

- 邀请(LDAP 或 OAuth2.0 账户):设置被邀请人的账号类型、企业邮箱和角色。被邀请人单击邮件中的 **Accept** 按钮激活账户后,然后单击**登录**自动跳转至 Dashboard 企业版登录页面。被邀请人使用企业邮箱账号和邮箱密码即可登录 Dashboard 企业版。

!!! note

开启 LDAP 后还支持自动注册。在登录页面选择 LDAP 方式输入未注册账号登录时,Dashboard 会自动注册该账号,但是角色权限为`user`。

- 创建账户(普通账户):设置新账户的登录名称、密码、角色。关于角色的详情,参见上文。

## 查看账户
Expand Down
12 changes: 12 additions & 0 deletions docs-2.0/nebula-dashboard-ent/system-settings/single-sign-on.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ NebulaGraph Dashboard 企业版支持普通账户、LDAP 账户和 OAuth2.0 账
|`User Filter` | `&(objectClass=*)` | 查询条件。 |
|`Email Key` | `mail`| LDAP 数据库存放邮箱信息的字段名。 |

### 使用说明

开启 LDAP 后有 2 种 LDAP 账号的注册方法:

- [邮箱邀请](../5.account-management.md):在**权限管理**页面创建账号时可以通过邮箱邀请别人进行注册,优点是可以设置账号的角色权限。

- 自动注册:在登录页面选择 LDAP 方式输入未注册账号登录时,Dashboard 会自动注册该账号,但是[角色权限](../5.account-management.md)`user`

## OAuth2.0 设置

!!! caution
Expand All @@ -49,3 +57,7 @@ NebulaGraph Dashboard 企业版支持普通账户、LDAP 账户和 OAuth2.0 账
|`Username Key` | `email`| 用户名字段。 |
|`Organization` | `vesoft company` | 组织名称。 |
|`OAuth权限范围`| `email`| OAuth 的权限范围。权限范围需要是厂商 OAuth2.0 平台配置的 scope 的子集,否则请求会失败。请求的 scope 需要能获取到 `Username Key`的值。|

### 使用说明

开启 OAuth2.0 后,在**权限管理**页面创建账号时可以通过邮箱[邀请](../5.account-management.md)别人进行注册。

0 comments on commit edcf907

Please sign in to comment.