系统管理员管理面板概述

系统管理员管理面板是ThingsBoard WEB UI中使用系统管理员登录之后的Web前端界面,在该面板下可以进行的操作有:租户管理、部件库管理、系统设置,其中租户是用于管理租户的模块;部件库管理是管理系统部件库的模块,系统管理员可以对部件库进行增、删、查、改等操作,这些部件库是提供给租户当作面板的模板使用的;系统设置是用于系统设置的模块,其分为常规设置、邮件设置、安全设置(Security setting)三个模块,常规设置可以设置系统的基础URL,邮箱设置可以设置系统的发件邮箱,安全设置时用于设置各种安全规则的模块。

租户管理

image.png

添加租户

image.png

  • 标题填写租户名称,其余如实填写即可。
  • Processing in isolated ThingsBoard Core container:在独立的容器中运行
  • Processing in isolated ThingsBoard Rule Engine container:在独立的容器中运行规则引擎

**

使用REST API添加租户
基本信息
**

  • 接口URL: /api/tenant
  • 请求方式: POST
  • Content-Type: application/json

接口请求参数
Header参数说明

参数名 示例值 是否必填 参数描述
X-Authorization Bearer jwttoken 必填 jwt token


Body参数 (application/json)**

  1. {
  2. "additionalInfo": "This is a tenant for testing",
  3. "address": "xxx路xxx号",
  4. "address2": "xxxxxx",
  5. "city": "柳州",
  6. "country": "中国",
  7. "email": "xxx@xxx.com",
  8. "isolatedTbCore": false,
  9. "isolatedTbRuleEngine": false,
  10. "phone": "19999999999",
  11. "region": "广西",
  12. "title": "Test tenant"
  13. }


参数说明**

参数名 示例值 是否必填 参数描述
additionalInfo This is a tenant for testing 必填 租户描述
address xxx路xxx号 必填 地址1
address2 xxxxxx 必填 地址2
city 柳州 必填 城市
country 中国 必填 国家
email xxx@xxx.com 必填 邮件地址
isolatedTbCore false 必填 是否在微服务中独立运行该租户的ThingsBoard核心
isolatedTbRuleEngine false 必填 是否在微服务中独立运行该租户的规则引擎
phone 19999999999 必填 手机号
region 广西 必填 省份
title Test tenant 必填 标题

管理租户管理员

添加租户管理员

image.png

  • 电子邮件:该管理员的Email地址(若激活方式为发送激活邮件邮件将发送到该邮箱,后续忘记密码也将通过此邮件地址找回)
  • 激活方式:
    • 显示激活链接:激活链接将直接弹窗显示点击即可激活该用户
    • 发送激活邮件:激活链接将通过邮件发送,用户点击之后即可激活用户


REST API 添加租户管理员

基本信息

  • 接口URL: /api/user?sendActivationMail=false
  • 请求方式: POST
  • Content-Type: application/json

请求参数

Query参数说明

参数名 示例值 是否必填 参数描述
sendActivationMail true 必填 是否通过邮件发送激活链接

Header参数说明

参数名 示例值 是否必填 参数描述
X-Authorization Bearer jwttoken 必填 jwt token


Body参数 (application/json)**

  1. {
  2. "email": "test2@test.com",
  3. "firstName": "test",
  4. "lastName": "test",
  5. "additionalInfo": {
  6. "description": "test",
  7. "defaultDashboardId": null,
  8. "defaultDashboardFullscreen": false
  9. },
  10. "authority": "TENANT_ADMIN",
  11. "tenantId": {
  12. "entityType": "TENANT",
  13. "id": "23166d30-48a8-11eb-9c95-fb8c2f11b872"
  14. }
  15. }


参数说明**

参数名 示例值 是否必填 参数描述
email test2@test.com 必填 邮件地址
firstName test 必填 名字
lastName test 必填
additionalInfo 必填 租户描述
additionalInfo.description test 必填 描述信息
additionalInfo.defaultDashboardId 必填
additionalInfo.defaultDashboardFullscreen false 必填
authority TENANT_ADMIN 必填 用户角色,参考值:SYS_ADMIN(系统管理员),TENANT_ADMIN(租户管理员)
tenantId 必填 租户实体
tenantId.entityType TENANT 必填 实体类型
tenantId.id 23166d30-48a8-11eb-9c95-fb8c2f11b872 必填 实体ID


查看用户激活链接

基本信息

  • 接口URL: /api/user/:userId/activationLink
  • 请求方式: GET

请求参数

路径参数

参数名 示例值 参数描述
userId 8d7f5dd0-48e4-11eb-93a3-a75ff26c74e5 用户id

Header参数说明

参数名 示例值 是否必填 参数描述
X-Authorization Bearer jwttoken 必填 jwt token