lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-11-24 08:33:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(sso): 单点登录消息推送模块增加 msgType 参数说明

Browse Source
This commit is contained in:
click33
2025-11-18 12:03:30 +08:00
parent ed35640765
commit a16552c3fe
2 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
sa-token-doc/sso/message-push.md
View File

@@ -23,12 +23,13 @@ http://{sso-server主机地址}/sso/pushS
| 参数 | 是否必填 | 说明 |
| :-------- | :-------- | :-------- |
| msgType | 是 | 消息类型，此处填 `checkTicket` |
| ticket | 是 | ticket 码 |
| client | 否 | 客户端标识，可不填，代表是一个匿名应用 |
| ssoLogoutCall | 否 | Client 端单点注销时 - 回调 URL 参数名称 (匿名 Client 时使用) |
| timestamp | 是 | 当前时间戳，13位 |
| nonce | 是 | 随机字符串 |
| sign | 是 | 签名，生成算法示例：`md5( client={client值}&nonce={随机字符串}&ticket={ticket码}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
| sign | 是 | 签名，生成算法示例：`md5( client={client值}&msgType={checkTicket}&nonce={随机字符串}&ticket={ticket码}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
**<font color="#080" >签名算法规则：将所有参数按照字典顺序依次排列（key除外，挂在最后面），然后进行 md5 摘要。以下不再赘述。</font>**
@@ -59,12 +60,13 @@ http://{sso-server主机地址}/sso/pushS
| 参数 | 是否必填 | 说明 |
| :-------- | :-------- | :-------- |
| msgType | 是 | 消息类型，此处填 `signout` |
| loginId | 是 | 账号id |
| client | 否 | 客户端标识，可不填，代表是一个匿名应用 |
| deviceId | 否 | 客户端设备 id |
| timestamp | 是 | 当前时间戳，13位 |
| nonce | 是 | 随机字符串 |
| sign | 是 | 签名，生成算法示例：`md5( client={client值}&deviceId={设备id}&nonce={随机字符串}&loginId={loginId}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
| sign | 是 | 签名，生成算法示例：`md5( client={client值}&deviceId={设备id}&msgType={signout}&nonce={随机字符串}&loginId={loginId}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
返回值示例：
``` js
@@ -90,11 +92,12 @@ http://{sso-client主机地址}/sso/pushC
| 参数 | 是否必填 | 说明 |
| :-------- | :-------- | :-------- |
| msgType | 是 | 消息类型，此处填 `logoutCall` |
| loginId | 是 | 账号id |
| deviceId | 否 | 客户端设备 id |
| timestamp | 是 | 当前时间戳，13位 |
| nonce | 是 | 随机字符串 |
| sign | 是 | 签名，生成算法示例：`md5( deviceId={设备id}&nonce={随机字符串}&loginId={loginId}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
| sign | 是 | 签名，生成算法示例：`md5( deviceId={设备id}&msgType={logoutCall}&nonce={随机字符串}&loginId={loginId}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
返回值示例：
``` js

6
sa-token-doc/sso/sso-apidoc.md
View File

@@ -76,8 +76,9 @@ http://{host}:{port}/sso/pushS
| :-------- | :-------- | :-------- |
| client | 否 | 客户端标识，可不填，代表是一个匿名应用 |
| timestamp | 是 | 当前时间戳，13位 |
| msgType | 是 | 消息类型 |
| nonce | 是 | 随机字符串 |
| sign | 是 | 签名，生成算法：`md5( client={client值}&nonce={随机字符串}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
| sign | 是 | 签名，生成算法：`md5( client={client值}&msgType={消息类型}&nonce={随机字符串}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
此接口可根据消息类型增加任意参数。新增加的参数要参与 sign 签名。
@@ -210,8 +211,9 @@ http://{host}:{port}/sso/pushC
| 参数 | 是否必填 | 说明 |
| :-------- | :-------- | :-------- |
| timestamp | 是 | 当前时间戳，13位 |
| msgType | 是 | 消息类型 |
| nonce | 是 | 随机字符串 |
| sign | 是 | 签名，生成算法：`md5( nonce={随机字符串}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
| sign | 是 | 签名，生成算法：`md5( msgType={消息类型}&nonce={随机字符串}&timestamp={13位时间戳}&key={secretkey秘钥} )` |
此接口可根据消息类型增加任意参数。新增加的参数要参与 sign 签名。