Idmapping相关--客户数据平台-火山引擎

文档中心

导航

客户数据平台

Idmapping相关

最近更新时间：2023.12.04 17:35:50首次发布时间：2023.10.08 10:43:09

1. 获取主体列表

基本信息

生效版本	1.18
功能描述	按项目id获取主体列表
接口模块	SubjectApi
接口名称	GetSubjects
请求类型	GET
权限校验	不需要权限校验

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	App id

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10

Body（无）

响应参数

名称	数据类型	描述
orgId	Integer	集团id
subjectId	Integer	主体id
subjectName	String	主体名称
subjectType	String	主体类型
defaultIdType	object	默认的base实体
defaultIdType.id	Integer	baseid的id
defaultIdType.subjectId	Integer	主体id
defaultIdType.code	String	基准code
defaultIdType.name	String	基准名
defaultIdType.dataType	String	基准ID类型的数据类型
defaultIdType.entityType	String	渠道标识
defaultIdType.needEncrypt	String	废弃
defaultIdType.finderIdType	String	Finder ID类型标识

返回示例

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "orgId": 0,
      "subjectId": 0,
      "subjectName": "string",
      "subjectType": "string",
      "defaultIdType": {
        "id": 0,
        "subjectId": 0,
        "code": "string",
        "name": "string",
        "dataType": "string",
        "entityType": "string",
        "needEncrypt": "string",
        "finderIdType": "string"
      }
    }
  ]
}

2. 获取主体下实体列表

基本信息

生效版本	1.18
功能描述	按主体id获取实体列表
接口模块	SubjectApi
接口名称	GetSubjectIdTypes
请求类型	GET
权限校验	不需要权限校验

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query

名称	数据类型	是否必选	描述	生效版本
subjectId	Int	是	主体id
user	String	否	双重用户鉴权	1.20
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10

Body（无）

响应参数：

名称	数据类型	描述
id	Integer	baseid的id
subjectId	Integer	主体id
code	String	基准code
name	String	基准名
dataType	String	基准ID类型的数据类型
entityType	String	渠道标识
needEncrypt	String	废弃
finderIdType	String	Finder ID类型标识

返回示例

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 2,
      "subjectId": 0,
      "code": "uid",
      "name": "uid",
      "dataType": "string",
      "entityType": "string",
      "needEncrypt": "string",
      "finderIdType": "string"
    }，
    {
      "id": 1,
      "subjectId": 0,
      "code": "baseid",
      "name": "baseid",
      "dataType": "string",
      "entityType": "string",
      "needEncrypt": "string",
      "finderIdType": "string"
    }
  ]
}