目录
通行证服务API DOC
接口地址:
http://monitor.szdatie.com:10211/
https://monitor.szdatie.com:10212/
接口列表
以下所有接口,除非有说明可匿名访问,所有接口默认需要提供 Token
请求头
会话
地址 | 说明 |
---|---|
POST /api/v1/idsvc/session/login | 登录(可匿名访问) |
POST /api/v1/idsvc/session/logout | 登出 |
GET /api/v1/idsvc/session/info | 当前登录信息 |
已登录账号接口
地址 | 说明 |
---|---|
POST /api/v1/idsvc/account/password/update | 修改登录密码 |
ID管理接口
以下接口仅 角色 为0:系统管理员
或1:平台管理员
可访问
地址 | 说明 |
---|---|
POST /api/v1/idsvc/manage/id/create | 创建账号 |
POST /api/v1/idsvc/manage/id/modify | 修改属性 |
POST /api/v1/idsvc/manage/id/attributes | 获取属性 |
GET /api/v1/idsvc/manage/id/list | 账号列表 |
POST /api/v1/idsvc/manage/id/lock | 锁定账号 |
POST /api/v1/idsvc/manage/id/unlock | 解锁账号 |
POST /api/v1/idsvc/manage/id/role/update | 更新角色 |
平台管理接口
以下接口仅 角色 为0:系统管理员
或1:平台管理员
可访问
地址 | 说明 |
---|---|
POST /api/v1/idsvc/manage/platform/create | 新建平台 |
POST /api/v1/idsvc/manage/platform/update | 修改平台 |
POST /api/v1/idsvc/manage/platform/delete | 删除平台 |
GET /api/v1/idsvc/manage/platform/list | 平台列表 |
POST /api/v1/idsvc/manage/platform/admin/set | 设置平台管理员 |
POST /api/v1/idsvc/manage/platform/admin/unset | 取消平台管理员 |
令牌管理
以下接口仅 角色 为0:系统管理员
或1:平台管理员
可访问
地址 | 说明 |
---|---|
GET /api/v1/idsvc/manage/token/list | 令牌列表 |
POST /api/v1/idsvc/manage/token/delete | 删除令牌 |
POST /api/v1/idsvc/manage/token/refresh | 刷新令牌有效期 |
POST /api/v1/idsvc/manage/token/remark/update | 更新令牌备注 |
机构接口
地址 | 说明 |
---|---|
GET /api/v1/idsvc/org/list | 获取机构列表 |
GET /api/v1/idsvc/org/info | 获取单个机构信息 |
POST /api/v1/idsvc/org/create | 创建机构 |
POST /api/v1/idsvc/org/update | 更新机构信息 |
POST /api/v1/idsvc/org/delete | 删除机构 |
GET /api/v1/idsvc/org/context | 获取当前账号在机构上下文中的信息 |
GET /api/v1/idsvc/org/name_info | 获取机构名信息 |
GET /api/v1/idsvc/org/member/list | 获取机构成员列表 |
POST /api/v1/idsvc/org/member/add | 添加机构成员 |
POST /api/v1/idsvc/org/member/update | 更新机构成员信息 |
POST /api/v1/idsvc/org/member/remove | 移除机构成员 |
账号角色
错误码
主错误码(code) ,0
表示成功,非0
表示失败,当失败时可根据子错误码(subCode)定位具体错误
专题平台前后端平滑更新流程
从专题服务创建账号、已有账号升级为通行证账号
- 专题服务后端,使用通行证服务的
平台管理员
账号,登录通行证服务
- 请求/api/v1/idsvc/manage/id/create 接口,创建通行证账号
- 如果不知道密码原文,
password
参数可以传递"___PasswordRequireUpdate___"
,并设置公共属性_passwordLoginAuthUrl
值为原平台的密码验证接口地址(http或https协议),当用户再次通过通行证登录时,通行证服务会携带登录名和密码原文请求该验证接口去验证密码,当密码正确,通行证服务会更新当前密码 - 设置公共属性,比如
name
和phoneNumber
- 如果不知道密码原文,
- 通行证账号创建成功,取得通行证ID
- 如果是创建原平台账号,则创建账号同时绑定通行证ID;如果是升级通行证账号,则直接给已有账号绑定通行证ID;
从通行证服务登录,并首次登入专题服务
- 专题前端请求专题服务后端登录接口
- 如果可以自动绑定,则在接口返回前完成账号绑定工作(升级为通行证账号);
- 如果不能自动绑定,可以返回更多信息告知前端当前账号是否已绑定通行证,前端展示GUI完成账号绑定。
Last modified
at 2025-06-05T11:00:05+08:00
Last modified on 2025-06-05T11:00:05+08:00
附件 (1)
- 登录系统流程.png (72.6 KB ) - added by at 2025-03-13T17:10:21+08:00.
Download all attachments as: .zip
Note:
See TracWiki
for help on using the wiki.