Skip to content

Commit 6ed98e7

Browse files
committed
更新飞书、钉钉、企微免密登录说明
1 parent d17916c commit 6ed98e7

File tree

9 files changed

+81
-13
lines changed

9 files changed

+81
-13
lines changed
783 KB
Loading
404 KB
Loading
351 KB
Loading
469 KB
Loading
607 KB
Loading
456 KB
Loading
654 KB
Loading

docs/img/system/weichat_oauth2.png

262 KB
Loading

docs/user_manual/X-Pack/login_auth.md

Lines changed: 81 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 登录认证
22
!!! Abstract ""
3-
MaxKB专业版支持 LDAP、CAS、OIDC、OAUTH2 单点认证协议,以及企业微信、钉钉、飞书移动端扫码登录验证,满足企业对于强身份验证和访问控制的需求。
3+
MaxKB专业版支持 LDAP、CAS、OIDC、OAUTH2 单点认证协议,以及企业微信、钉钉、飞书移动端扫码登录和免密,满足企业对于强身份验证和访问控制的需求。
44

55
## 1 LDAP
66

@@ -32,9 +32,14 @@
3232
**说明:** OAUTH2 回调地址即 MaxKB 访问地址加上`/api/oauth2`,例如:`http://40.100.86.240:8080/api/oauth2`
3333
![OAHTU2](../../img/system/oauth2.png)
3434

35-
## 5 扫码登录
35+
## 5 平台对接
3636

37-
### 5.1 企业微信扫码登录
37+
!!! Abstract ""
38+
支持企业微信平、钉钉、飞书接入,支持扫码登录、免密登录等。
39+
40+
### 5.1 企业微信对接
41+
42+
#### 5.1.1 企业微信对接设置
3843

3944
!!! Abstract ""
4045
企业微信扫码登录配置参数说明:
@@ -47,6 +52,7 @@
4752
!!! Abstract ""
4853
MaxKB 配置企业微信扫码登录时,需要企业微信管理员登录 [企业微信管理管理](https://work.weixin.qq.com/wework_admin/frame) 并创建企业自建应用,完成配置后发布应用。
4954
第一步:创建应用。在【应用管理-应用-自建】中点击【创建应用】,输入应用名称等信息,应用创建完成后即可查看应用Agent ID和Secret。
55+
5056
![企微应用创建](../../img/system/qiwei_create_app.png){width="500px"}
5157

5258
![企微应用信息](../../img/system/qiwei_appinfo.png){width="500px"}
@@ -67,7 +73,31 @@
6773
完成企业微信应用的配置和发布后,在 MaxKB 企业微信登录扫码配置页面配置相应信息并通过效验。
6874
![企业微信配置](../../img/system/qiwei_setting.png)
6975

70-
### 5.2 钉钉扫码登录
76+
!!! Abstract ""
77+
后续即可在 MaxKB 登陆页面点击选择企业微信进行扫码登陆。
78+
79+
#### 5.1.2 企业微信免登设置
80+
81+
!!! Abstract ""
82+
应用主页地址的构造可以参考企业微信开发指南[造网页授权链接——构造企业oauth2链接](https://developer.work.weixin.qq.com/document/path/91120#%E6%9E%84%E9%80%A0%E4%BC%81%E4%B8%9Aoauth2%E9%93%BE%E6%8E%A5)
83+
链接格式即参数说明如下:
84+
85+
- 链接格式:https://open.weixin.qq.com/connect/oauth2/authorize?appid=CORPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&agentid=AGENTID&state=STATE#wechat_redirect
86+
- CORPID: 企业的CorpID
87+
- REDIRECT_URI:授权后重定向的回调链接地址,需要使用urlencode对链接进行处理,例如:https%3A%2F%2Fmk-enterprise.fit2cloud.cn/api/wecom/oauth2,调整域名部分即可
88+
- SCOPE:填 snsapi_base 即可
89+
- AGENTID:应用 ID
90+
91+
主页地址示例: https://open.weixin.qq.com/connect/oauth2/authorize?redirect_uri=https%3A%2F%2Fmk-enterprise.fit2cloud.cn/api/wecom/oauth2&response_type=code&scope=snsapi_privateinfo&agentid=1000008&appid=ww5fad05adxxxx&state=maxkb#wechat_redirect
92+
93+
![企业微信配置](../../img/system/weichat_oauth2.png)
94+
95+
!!! Abstract ""
96+
配置完成后,在企业微信工作台中找到 MaxKB 应用,免登访问 MaxKB。
97+
98+
### 5.2 钉钉对接
99+
100+
#### 5.2.1 钉钉对接设置
71101

72102
!!! Abstract ""
73103
钉钉扫码登录配置参数说明:
@@ -80,19 +110,44 @@
80110
!!! Abstract ""
81111
MaxKB 配置钉钉扫码登录时,需要在 [钉钉开放平台](https://open-dev.dingtalk.com/) 创建应用并进行配置。
82112

83-
第一步:创建应用。在【应用开 发-钉钉应用】中点击【创建应用】,应用创建完后在【凭证与基础信息】可查案APPKey和 APPSecret信息。
113+
(1)创建应用。在【应用开发-钉钉应用】中点击【创建应用】,应用创建完后在【凭证与基础信息】可查案APPKey和 APPSecret信息。
84114
![钉钉创建应用](../../img/system/dingding_app_create.png)
85115
![钉钉应用信息](../../img/system/dingding_app_info.png)
86116

87117
!!! Abstract ""
88-
第二步:发布应用。在【版本管理与发布】中,填写应用版本号、版本描述等信息,点击【保持】,发布应用。
118+
(2)发布应用。在【版本管理与发布】中,填写应用版本号、版本描述等信息,点击【保持】,发布应用。
89119
![钉钉应用信息](../../img/system/dingding_app_release.png)
90120

91121
!!! Abstract ""
92122
完成配置后发布,然后在 MaxKB 钉钉扫码登录扫码配置页面进行配置并保存。
93123
![钉钉创建应用](../../img/system/dingding_setting.png)
94124

95-
### 5.3 飞书扫码登录
125+
!!! Abstract ""
126+
后续即可在 MaxKB 登陆页面点击选择钉钉进行扫码登陆。
127+
128+
#### 5.2.2 钉钉免登设置
129+
130+
!!! Abstract ""
131+
(1)添加网页应用能力。在钉钉开放平台的【应用能力】中,添加【网页应用】,并设置【应用首页】和【PC端首页地址】。
132+
133+
![钉钉创建应用](../../img/system/dingding_add_webapp.png)
134+
135+
![钉钉应用配置](../../img/system/dingding_webapp_config.png)
136+
137+
!!! Abstract ""
138+
(2)安全设置。在【安全设置】中设置重定向URL和端内免登录地址。
139+
![钉钉安全配置](../../img/system/dingding_security_config.png)
140+
141+
!!! Abstract ""
142+
(3)分享设置,在【接入登录】中设置【回调域名】。
143+
![钉钉安全配置](../../img/system/dingding_share_config.png)
144+
145+
!!! Abstract ""
146+
应用发布后,即可在钉钉工作台免登录访问 MaxKB。
147+
148+
### 5.3 飞书对接
149+
150+
#### 5.3.1 飞书对接设置
96151

97152
!!! Abstract ""
98153
飞书扫码登录配置参数说明:
@@ -108,19 +163,32 @@
108163
MaxKB 配置飞书扫码登录时,需要在 [飞书开放平台](https://open.feishu.cn/) 创建企业自建应用,完成配置后发布,然后在 MaxKB 飞书扫码登录扫码配置页面进行配置并保存。
109164

110165
!!! Abstract ""
111-
第一步:创建企业自建应用。点击【创建企业自建应用】,输入应用名称、描述以及上传应用图标后,点击【创建】。
166+
(1)创建企业自建应用。点击【创建企业自建应用】,输入应用名称、描述以及上传应用图标后,点击【创建】。
112167
![飞书创建](../../img/system/feishu_create_app.png)
113168

114169
!!! Abstract ""
115-
第二步:配置重定向URL。在【开发配置-安全设置】中,输入MaxKB 飞书扫码配置弹出框中的回调地址,点击【添加】。
170+
(2)配置重定向URL。在【开发配置-安全设置】中,输入MaxKB 飞书扫码配置弹出框中的回调地址,点击【添加】。
116171
![飞书配置回调URL](../../img/system/feishu_url.png)
117172

118173
!!! Abstract ""
119-
第三步:发布应用。在【版本管理与发布】中,输入应用版本号、更新说明等信息,点击【保存】,完成应用发布。
174+
(3)发布应用。在【版本管理与发布】中,输入应用版本号、更新说明等信息,点击【保存】,完成应用发布。
120175
![飞书发布应用](../../img/system/feishu_app_release.png)
121176

122-
## 6 登陆认证
177+
!!! Abstract ""
178+
发布应用后,即可在 MaxKB 登陆页面点击选择飞书进行扫码登陆。
179+
180+
#### 5.3.2 飞书免登设置
181+
182+
!!! Abstract ""
183+
(1)添加页面应用,并配置桌面主页,例如:配置中填写 桌面端主页地址,如我们的测试环境地址:https://mk-enterprise.fit2cloud.cn/ui/login?client=lark&appId=cli_a7e1c1ddexxxxx
184+
185+
![飞书添加页面应用](../../img/system/feishu_add_webapp.png)
186+
![飞书页面应用配置](../../img/system/feishu_webapp_config.png)
187+
188+
!!! Abstract ""
189+
(2)在【安全设置】中添加重定向 URL。
190+
191+
![飞书安全配置](../../img/system/feishu_security_config.png)
123192

124193
!!! Abstract ""
125-
完成认证信息配置后,在登陆页面点击选择对应的认证方式进行登陆。
126-
![登陆认证](../../img/system/auth_login.png)
194+
应用发布后,即可在飞书工作台免登录访问 MaxKB。

0 commit comments

Comments
 (0)