1. 管理后台接口
标准Open API
  • 管理后台接口
    • 开发前必读
    • 身份管理
      • 用户
        • 校验账号是否存在
        • 人员查询接口
        • 创建账号
        • 用户封禁接口
        • 用户注销接口(当前浏览器登入的会话)
        • 验证用户token是否有效
        • 用户注销登录 (用户所有登入会话包括终端)
        • 批量用户注销登录(标准版本不支持)
        • 获取终端用户在线状态(v4.0.11.8版本及以上可用)
      • 组织架构
        • 从指定用户组中移除指定账号
        • 校验指定用户组中是否有某个账号
        • 添加账号到指定用户组
        • 部门查询接口
    • 应用管理
      • HTTP应用
        • 域名端口存在校验
        • 应用发布
        • 应用更新
        • 删除应用(v4.0.10.3以上)
        • 应用详情(v4.0.10.3以上)
        • 应用列表接口(v4.0.8.0以上)
      • 隧道网关
        • 获取用户sdp网关接入状态
        • 创建隧道应用(v4.0.10.3以上)
        • 更新隧道应用(v4.0.10.3以上)
        • 删除隧道应用(v4.0.10.3以上)
        • 查询隧道应用详情(v4.0.10.3以上)
        • 下线sdp隧道连接(v4.0.12.4以上)
      • 授权管理
        • 添加HTTP应用到指定授权组
        • 授权策略详情(v4.0.10.3以上)
        • 授权策略列表查询(v4.0.10.3以上)
        • 更新授权策略(v4.0.10.3以上)
        • 创建授权策略(v4.0.10.3以上)
    • 主机运维网关
      • 主机组列表
      • 授权主机(主机添加负责人)
    • 终端管理
      • 资产管理
        • (新)删除可信资产(适用版本:4.0.11.0及以上)
        • (新)添加可信资产(适用版本:4.0.11.0及以上)
        • (新)获取可信资产列表(适用版本:4.0.11.0及以上)
        • (旧)删除可信资产(适用版本:4.0.8.0~4.0.10.X)
        • (旧)添加可信资产(适用版本:4.0.8.0~4.0.10.X)
        • (旧)获取可信资产列表(适用版本:4.0.8.0~4.0.10.0X)
      • 终端
        • 客户端注销登录
        • 终端状态信息拉取(4.0.8.1及以上版本支持)
        • 终端状态信息推送接口(4.0.8.1及以上版本支持)
        • 终端推送升级(4.0.11.0以上版本)
    • 组件管理
      • HTTP应用网关
        • 修改网关模式(4.0.8.0及以上版本可用)
        • 网关列表
    • 身份输出
      • 开发必读
      • 用户
        • 用户全量拉取(4.0.8.0及以上版本支持)
        • 用户增量拉取(4.0.8.0及以上版本支持)
      • 组织架构
        • 组织机构增量拉取(4.0.8.0及以上版本支持)
        • 组织机构全量拉取(4.0.8.0及以上版本支持)
    • API接口同步
      • API同步
    • IP地址池
      • 创建IP地址池(v4.0.15.0及以上)
      • 更新IP地址池(v4.0.15.0及以上)
      • 删除IP地址池(v4.0.15.0及以上)
      • 获取IP地址池列表(v4.0.15.0及以上)
  • 应用系统SSO对接
    • 零信任平台 OAuth2.0 协议对接指南
    • 零信任平台Cas协议对接指南
    • 零信任平台JWT协议对接指南
    • 零信任平台简易 SSO 对接指南
  1. 管理后台接口

开发前必读

开发前必读(可参考下面:接口调用过程和样例参考代码)#

服务端所有接口受安全保护,调用时都需要将请求的API地址URI以及参数进行签名。
使用签名时的appid以及secret参数由服务方零信任管理平台生成并提供给研发人员。
image.png
每个接口都需要传递签名信息,见以下签名示例。
所有的接口地址:
以/ztpManage/开头的接口,请求地址为管理后台的地址如:http://管理后台服务ip:10444 (需要接口签名)
以/portal/开头的接口,请求地址为Portal认证登入地址如:https://portal对外地址:10443 (无需接口签名)

签名过程#

1.

sign 签名参数获取方式:#

appid=服务方提供的appId
timestamp=秒级时间戳
secret=服务方提供的秘钥,不要在接口中传输
2.

签名计算过程#

1.
获取appid
2.
获取secret
3.
生成当前时间戳timestamp
4.
根据不同请求方式
1.
GET、DELETE需要将uri?后的参数和appid,secret,timestamp按照参数名字典顺序(ASCII排序)排序拼接将uri path拼接在后面生成字符串
2.
POST、PATCH、PUT需要将body中的字符串清除 /r、/n、空格后,拼接清除后的body字符串、appid,secret,timestamp和uri path生成字符串
5.
进行md5计算(小写)
3.

示例#

GET、DELETE请求示例:
1.请求的url为 http://example.com/v1/user/info?age=10&name=bob&appid=10001&timestamp=1597920990
2.拼接参数生成字符串:
age=10appid=10001name=bobsecret=lnlLIulnGFY56GYTbtimestamp=1597920990/v1/user/info
3.进行md5加密后为sign
4.最后请求的url为:http://example.com/v1/user/info?age=10&name=bob&appid=10001&timestamp=1597920990&sign=39ad722621ccfe0c8ca3771392f5cd5f

POST、PATCH、PUT请求示例
例如:
1.请求的url为:http://example.com/v1/user/info?appid=10001&timestamp=1597920990
2.参数(body中,格式为json):{"isOut":1,"userid":"longhai","userstatus":"Inactive"}
3.拼接字符串(body中的参数参数固定拼接在最前方):{"isOut":1,"userid":"longhai","userstatus":"Inactive"}appid=10001secret=GposYScGxEkJcwptimestamp=1658237343/ztpManage/v1/user/info
4.清除/r、/n、空格后,进行md5加密后为sign
5.最后请求的url为: http://example.com/v1/user/info?appid=10001&timestamp=1597920990&sign=39ad722621ccfe0c8ca3771392f5cd5f
参数(body中,格式为json):{"isOut":1,"userid":"longhai","userstatus":"Inactive"}

接口调用过程和样例参考代码#

接口事例demo涉及:身份管理,应用管理,终端管理,组件管理,身份输出,api接口同步等。实现了两种开发语言Python 和Java.
其中:
openApi接口地址: https://ztp.xxx.example.com:10444 (零信任管理后台地址,内部的服务器地址ip+10444)
openApi接口appid和secret,通过如下图进行创建:
image.png
Python 实例代码
Python 代码(点击展开查看源码 openapi.py)
Java 实例代码
Java 代码(点击展开查看源码 pom.xml)
Java 代码(点击展开查看源码 OpenApiClient.java)
修改于 2026-04-16 09:53:03
下一页
校验账号是否存在
Built with