- 【对外】ABI OpenAPI 用户手册
- 1. 整体流程
- 2. 凭证申请
- 3. 接口调用限制
- 4. 相关错误码
- 5. 使用场景
- 5.1 仪表盘嵌入
- 5.2 开放接口文档
- 5.2.1 用户、用户组、权限相关
- 创建用户组
- 查询项目下的用户组列表
- 查询用户组成员
- 删除用户组成员
- 添加用户组成员
- 从项目中删除用户
- 添加用户到项目中
- 关联系统级别用户组到项目中
- 获取项目列表
- 获取项目用户列表
- 授权接口/回收权限接口（接口行为是覆盖，即actions传的是什么权限，调用接口后，用户最终就是什么权限）
- 开启屏蔽组授权
- 按照员工类型屏蔽资源上的组授权
- 批量刷新权限系统权限
- 获取资源授权明细
- 更改用户属性接口
- 删除用户属性接口
- 获取数据权限成员接口
- 添加数据权限成员接口
- 删除数据权限成员接口
- 获取数据集上的行列权限规则列表
- 数据集上新建行列权限
- 数据集上删除行列权限
- 数据集上修改行列权限
- 获取数据集上指定人的行列权限规则列表
- 在数据集上指定用户授权指定数据权限规则
【对外】ABI OpenAPI 用户手册
【对外】ABI OpenAPI 用户手册
💡
字节内使用请将sessionid替换为titan_passport_id
1.
整体流程
1.
为每一个openapi调用方生成一个client id 和 client secret，并且要求每一个client绑定一个真实的用户身份（通过用户的sessionid），形成信任链
2.
用户使用 client id / secret 调用接口交换包含用户身份信息的jwt token
3.
用户在调用业务接口时在请求头部带上jwt token，例如：
Authorization: Bearer jwt_token
4.
ABI在接口被调用时，使用公钥校验jwt token，完成限流检查、审计
5.
在调用任意一个 ABI 接口时，为了便于后续问题的排查，建议在请求的 headers 中添加 `x-request-id` 和 `request-id`(保证唯一字符串即可)， 需要两个 header 是因为 abi 整体组件比较多，各个组件之间使用的标记可能不同。这两个参数会被输入到 ABI 的后端日志中，为您在遇到问题时进行分析和定位提供有力的支持，从而更高效地解决可能出现的故障。
6.
不同环境 token 不互通，例如在 cn 环境申请了 token，不可以拿到 va 或者其他环境使用。
7.
返回业务结果
整体流程如下：
流程图