跳转至

添加用户到租户

接口概述

本接口用于将用户与租户进行绑定,一个租户可以注册多个用户,请求头中传入租户和用户ID,注意用户必须是租户创建者,传入的account参数为当前想要挂载到当前租户下的用户

接口 URL

POST  Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/user/registerToTenant

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式支持: UID(基于用户ID认证) TOKEN(基于令牌认证)。
auth-value String 32 与选定的auth-type相对应的认证值。

公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

image.png

请求参数

参数 类型 是否必选 最大长度 描述 示例值
userId Long 32 需要注册的用户id 338979817842016256
role String 16 权限角色,枚举值如下: ADMIN:管理员 ANALYST:指标定义者 USAGER:指标使用者 ADMIN

响应参数

参数 类型 是否必选 最大长度 描述 示例值
code String 32 接口响应码 200
success Boolean 请求成功与否 true
errorMsg String 512 报错信息 null
detailErrorMsg String 报错详情 null
traceId String 128 traceId fdde6861bd554805998343f9ff2dcd70.292.16857691758642861
data Boolean 结果 true/false

请求示例

{
    "userId": "478220996092887040",
    "role": "ADMIN"
}

响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "2bc7df9f294144deab6535e0b2a9b546.157.17234476290340999"
}