Skip to content

Commit

Permalink
更新X-Pack 登陆认证以及系统API内容
Browse files Browse the repository at this point in the history
  • Loading branch information
guoxiaoyong committed Sep 28, 2024
1 parent 4699938 commit 10a94bb
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 28 deletions.
Binary file modified docs/img/FAQ/MaxKBaddModel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/system/apikey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/system/apikey_setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/system/auth_login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/system/swagger_api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 12 additions & 22 deletions docs/user_manual/X-Pack/login_auth.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,30 @@
# 登录认证
!!! Abstract ""
MaxKB专业版已经支持LDAP、CAS、OIDC三种单点登录方式,基本满足了企业对于强身份验证和访问控制的需求
MaxKB专业版已经支持LDAP、CAS、OIDC三种单点登录方式,满足企业对于强身份验证和访问控制的需求

## LDAP
## 1 LDAP

!!! Abstract ""
支持在系统设置中进行 LDAP 配置,开启此功能跳转到登录页面即可使用相应方式登录。
!!! Abstract ""
配置 LDAP 的过程可参考下图,注意勾选下方"启用 LDAP 认证"后开启此功能。
提示: 配置完成可点击上方【测试连接】即时测试配置信息是否正确,网络是否连通。
提示:配置完成可点击上方【测试连接】即时测试配置信息是否正确,网络是否连通。
![LDAP](../../img/system/LDAP.png)

!!! Abstract ""
配置完成后,随即跳转到登录页面即可使用 LDAP 方式登录。

![LDAP登录](../../img/system/LDAP_login.jpg)

## CAS
## 2 CAS

!!! Abstract ""
支持在系统设置中进行 CAS 配置,开启此功能跳转到登录页面即可使用相应方式登录。
!!! Abstract ""
配置 CAS 的过程可参考下图,注意勾选下方"启用 CAS 认证"后开启此功能。
![CAS](../../img/system/CAS.jpg)

!!! Abstract ""
配置完成后,随即跳转到登录页面即可使用 CAS 方式登录。

![CAS登录](../../img/system/CAS_login.jpg)

## OIDC
## 3 OIDC

!!! Abstract ""
支持在系统设置中进行 OIDC 配置,开启此功能跳转到登录页面即可使用相应方式登录。
!!! Abstract ""
配置 OIDC 的过程可参考下图,注意勾选下方"启用 OIDC 认证"后开启此功能。
![OIDC](../../img/system/OIDC.jpg)

!!! Abstract ""
配置完成后,随即跳转到登录页面即可使用 OIDC 方式登录。
## 4 登陆认证

![OIDC登录](../../img/system/OIDC_login.jpg)
!!! Abstract ""
完成认证信息配置后,在登陆页面点击选择对应的认证方式进行登陆。
![OIDC](../../img/system/auth_login.png)
18 changes: 12 additions & 6 deletions docs/user_manual/X-Pack/system_API.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# 系统API

## 1 系统 API Key 管理
## 1 API Key 管理

!!! Abstract ""
对 API Key 的管理,包括创建、复制、设置、启用/禁用和删除的操作。
![API-key](../../img/system/API_Key.jpg)
在页面右上方登陆用户图标下拉菜单中,点击「API Key管理」菜单,进入API Key 管理窗口,可以创建、启用/关闭、删除、设置 API Key等操作。

## 2 系统 API 文档
![API-key](../../img/system/apikey.png)

!!! Abstract ""
用户可通过【创建】获取到 API Key 进行授权
创建 API Key之后,可以配置是否允许跨域地址,默认不允许

![swagger](../../img/system/swagger.jpg)
![API-key](../../img/system/apikey_setting.png)

## 2 API 调试

!!! Abstract ""
打开 API 文档地址后,输入 API Key 进行授权,即可进行 API 在线调试。

![swagger](../../img/system/swagger_api.png)


0 comments on commit 10a94bb

Please sign in to comment.