登录 注册
开源 企业版 高校版 私有云 Gitee AI NEW
扫描微信二维码支付
取消
支付完成
Watch
不关注 关注所有动态 仅关注版本发行动态 关注但不提醒动态
3 Star 6 Fork 2

ThingsKit / ThingsKit物联网平台文档

代码 Issues 0 Pull Requests 0 Wiki 统计 流水线
服务
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目，私有仓库也完全免费 ：）
免费加入
克隆/下载
index.md 55.28 KB
一键复制 编辑 原始数据 按行查看 历史
TrueVoid 提交于 2023-01-18 20:20 . docs: release1.0.1

修改用户信息

接口地址:/api/yt/user

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "accountExpireTime": "",
  "activateToken": "",
  "avatar": "",
  "createTime": "",
  "creator": "",
  "customerId": "",
  "email": "",
  "enabled": false,
  "hasPassword": false,
  "id": "",
  "level": 0,
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "remark": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "tbUser": "",
  "tenantId": "",
  "tenantName": "",
  "updateTime": "",
  "updater": "",
  "userStatusEnum": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

deleteUser（待翻译）

接口地址:/api/yt/user

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
deleteDTO DeleteDTO body true DeleteDTO
  ids 删除ID列表 true array

响应参数:

参数名称 参数说明 类型
errorCode Platform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden) object
message Error message string
status HTTP Response Status Code integer(int32)
timestamp Timestamp string(date-time)

响应示例:

{}

accountExist（待翻译）

接口地址:/api/yt/user/account_exist/{username}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
username username path true string

响应参数:

参数名称 参数说明 类型
code integer(int32)
data UserDTO
  accountExpireTime 账号失效时间 string(date-time)
  activateToken 激活token string
  avatar 头像 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  customerId 客户ID string
  email 邮箱 string
  enabled 账号状态 boolean
  hasPassword 是否已重置密码 boolean
  id ID string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
  organizationIds 所辖组织ids array
  password 密码 string
  phoneNumber 电话号码 string
  realName 真实名称 string
  remark 备注 string
  roleIds 角色ids array
  roles 角色信息列表 array
    roleId 角色ID string
    roleName 角色名称 string
  tbUser TB的UserId string
  tenantId 租户ID string
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
  username 用户名 string
message string

响应示例:

{
	"code": 0,
	"data": {
		"accountExpireTime": "",
		"activateToken": "",
		"avatar": "",
		"createTime": "",
		"creator": "",
		"customerId": "",
		"email": "",
		"enabled": false,
		"hasPassword": false,
		"id": "",
		"level": 0,
		"organizationIds": [],
		"password": "",
		"phoneNumber": "",
		"realName": "",
		"remark": "",
		"roleIds": [],
		"roles": [
			{
				"roleId": "",
				"roleName": ""
			}
		],
		"tbUser": "",
		"tenantId": "",
		"tenantName": "",
		"updateTime": "",
		"updater": "",
		"userStatusEnum": "",
		"username": ""
	},
	"message": ""
}

修改个人中心

接口地址:/api/yt/user/center

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "accountExpireTime": "",
  "activateToken": "",
  "avatar": "",
  "createTime": "",
  "creator": "",
  "customerId": "",
  "email": "",
  "enabled": false,
  "hasPassword": false,
  "id": "",
  "level": 0,
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "remark": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "tbUser": "",
  "tenantId": "",
  "tenantName": "",
  "updateTime": "",
  "updater": "",
  "userStatusEnum": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO

响应参数:

参数名称 参数说明 类型
accountExpireTime 过期时间 string(date-time)
avatar 头像 string
createTime 创建时间 string(date-time)
email 邮箱 string
homePath 主页地址 string
needSetPwd 是否需要重置密码 boolean
phoneNumber 手机 string
plainRoles 角色信息 array
  roleId 角色ID string
  roleName 角色名称 string
realName 姓名 string
roles 角色ID array
tenantId 租户ID string
tenantName 租户名称 string
userId 用户ID string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"avatar": "",
	"createTime": "",
	"email": "",
	"homePath": "",
	"needSetPwd": false,
	"phoneNumber": "",
	"plainRoles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"realName": "",
	"roles": [],
	"tenantId": "",
	"tenantName": "",
	"userId": "",
	"username": ""
}

获取租户下对应组织的所有客户

接口地址:/api/yt/user/customers/{organizationId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
organizationId organizationId path true string

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

[
	{
		"accountExpireTime": "",
		"activateToken": "",
		"avatar": "",
		"createTime": "",
		"creator": "",
		"customerId": "",
		"email": "",
		"enabled": false,
		"hasPassword": false,
		"id": "",
		"level": 0,
		"organizationIds": [],
		"password": "",
		"phoneNumber": "",
		"realName": "",
		"remark": "",
		"roleIds": [],
		"roles": [
			{
				"roleId": "",
				"roleName": ""
			}
		],
		"tbUser": "",
		"tenantId": "",
		"tenantName": "",
		"updateTime": "",
		"updater": "",
		"userStatusEnum": "",
		"username": ""
	}
]

判断电话是否重复

接口地址:/api/yt/user/get_user/{phoneNumber}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
phoneNumber phoneNumber path true string

响应参数:

参数名称 参数说明 类型
code integer(int32)
data UserDTO
  accountExpireTime 账号失效时间 string(date-time)
  activateToken 激活token string
  avatar 头像 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  customerId 客户ID string
  email 邮箱 string
  enabled 账号状态 boolean
  hasPassword 是否已重置密码 boolean
  id ID string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
  organizationIds 所辖组织ids array
  password 密码 string
  phoneNumber 电话号码 string
  realName 真实名称 string
  remark 备注 string
  roleIds 角色ids array
  roles 角色信息列表 array
    roleId 角色ID string
    roleName 角色名称 string
  tbUser TB的UserId string
  tenantId 租户ID string
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
  username 用户名 string
message string

响应示例:

{
	"code": 0,
	"data": {
		"accountExpireTime": "",
		"activateToken": "",
		"avatar": "",
		"createTime": "",
		"creator": "",
		"customerId": "",
		"email": "",
		"enabled": false,
		"hasPassword": false,
		"id": "",
		"level": 0,
		"organizationIds": [],
		"password": "",
		"phoneNumber": "",
		"realName": "",
		"remark": "",
		"roleIds": [],
		"roles": [
			{
				"roleId": "",
				"roleName": ""
			}
		],
		"tbUser": "",
		"tenantId": "",
		"tenantName": "",
		"updateTime": "",
		"updater": "",
		"userStatusEnum": "",
		"username": ""
	},
	"message": ""
}

获取当前用户信息

接口地址:/api/yt/user/me/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

暂无

响应参数:

参数名称 参数说明 类型
accountExpireTime 过期时间 string(date-time)
avatar 头像 string
createTime 创建时间 string(date-time)
email 邮箱 string
homePath 主页地址 string
needSetPwd 是否需要重置密码 boolean
phoneNumber 手机 string
plainRoles 角色信息 array
  roleId 角色ID string
  roleName 角色名称 string
realName 姓名 string
roles 角色ID array
tenantId 租户ID string
tenantName 租户名称 string
userId 用户ID string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"avatar": "",
	"createTime": "",
	"email": "",
	"homePath": "",
	"needSetPwd": false,
	"phoneNumber": "",
	"plainRoles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"realName": "",
	"roles": [],
	"tenantId": "",
	"tenantName": "",
	"userId": "",
	"username": ""
}

获取用户分页数据

接口地址:/api/yt/user/page{?orderFiled,orderType,organizationId,page,pageSize,realName,roleType,tenantId,username}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int

响应参数:

参数名称 参数说明 类型
items array
  accountExpireTime 账号失效时间 string(date-time)
  activateToken 激活token string
  avatar 头像 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  customerId 客户ID string
  email 邮箱 string
  enabled 账号状态 boolean
  hasPassword 是否已重置密码 boolean
  id ID string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
  organizationIds 所辖组织ids array
  password 密码 string
  phoneNumber 电话号码 string
  realName 真实名称 string
  remark 备注 string
  roleIds 角色ids array
  roles 角色信息列表 array
    roleId 角色ID string
    roleName 角色名称 string
  tbUser TB的UserId string
  tenantId 租户ID string
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
  username 用户名 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"accountExpireTime": "",
			"activateToken": "",
			"avatar": "",
			"createTime": "",
			"creator": "",
			"customerId": "",
			"email": "",
			"enabled": false,
			"hasPassword": false,
			"id": "",
			"level": 0,
			"organizationIds": [],
			"password": "",
			"phoneNumber": "",
			"realName": "",
			"remark": "",
			"roleIds": [],
			"roles": [
				{
					"roleId": "",
					"roleName": ""
				}
			],
			"tbUser": "",
			"tenantId": "",
			"tenantName": "",
			"updateTime": "",
			"updater": "",
			"userStatusEnum": "",
			"username": ""
		}
	],
	"total": 0
}

修改密码

接口地址:/api/yt/user/reset

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "resetPassword": "",
  "userId": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
密码修改 密码修改 body true 密码修改
  resetPassword 新密码 true string
  userId 用户ID true string

响应参数:

参数名称 参数说明 类型
code integer(int32)
data boolean
message string

响应示例:

{
	"code": 0,
	"data": true,
	"message": ""
}

saveTenantAdmin（待翻译）

接口地址:/api/yt/user/save_tenant_admin

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accountExpireTime": "",
  "activateToken": "",
  "avatar": "",
  "createTime": "",
  "creator": "",
  "customerId": "",
  "email": "",
  "enabled": false,
  "hasPassword": false,
  "id": "",
  "level": 0,
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "remark": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "tbUser": "",
  "tenantId": "",
  "tenantName": "",
  "updateTime": "",
  "updater": "",
  "userStatusEnum": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

获取租户管理员分页数据

接口地址:/api/yt/user/tenant/page{?orderFiled,orderType,page,pageSize,tenantId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int
tenantId tenantId true string

响应参数:

参数名称 参数说明 类型
items array
  accountExpireTime 账号失效时间 string(date-time)
  activateToken 激活token string
  avatar 头像 string
  createTime 创建时间 string(date-time)
  creator 创建用户 string
  customerId 客户ID string
  email 邮箱 string
  enabled 账号状态 boolean
  hasPassword 是否已重置密码 boolean
  id ID string
  level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
  organizationIds 所辖组织ids array
  password 密码 string
  phoneNumber 电话号码 string
  realName 真实名称 string
  remark 备注 string
  roleIds 角色ids array
  roles 角色信息列表 array
    roleId 角色ID string
    roleName 角色名称 string
  tbUser TB的UserId string
  tenantId 租户ID string
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
  username 用户名 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"accountExpireTime": "",
			"activateToken": "",
			"avatar": "",
			"createTime": "",
			"creator": "",
			"customerId": "",
			"email": "",
			"enabled": false,
			"hasPassword": false,
			"id": "",
			"level": 0,
			"organizationIds": [],
			"password": "",
			"phoneNumber": "",
			"realName": "",
			"remark": "",
			"roleIds": [],
			"roles": [
				{
					"roleId": "",
					"roleName": ""
				}
			],
			"tbUser": "",
			"tenantId": "",
			"tenantName": "",
			"updateTime": "",
			"updater": "",
			"userStatusEnum": "",
			"username": ""
		}
	],
	"total": 0
}

getUser

接口地址:/api/yt/user/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userId userId path true string

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

新增用户

接口地址:/api/yt/user{?sendEmail,sendMsg}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accountExpireTime": "",
  "activateToken": "",
  "avatar": "",
  "createTime": "",
  "creator": "",
  "customerId": "",
  "email": "",
  "enabled": false,
  "hasPassword": false,
  "id": "",
  "level": 0,
  "organizationIds": [],
  "password": "",
  "phoneNumber": "",
  "realName": "",
  "remark": "",
  "roleIds": [],
  "roles": [
    {
      "roleId": "",
      "roleName": ""
    }
  ],
  "tbUser": "",
  "tenantId": "",
  "tenantName": "",
  "updateTime": "",
  "updater": "",
  "userStatusEnum": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userDTO UserDTO body true UserDTO

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

{
	"accountExpireTime": "",
	"activateToken": "",
	"avatar": "",
	"createTime": "",
	"creator": "",
	"customerId": "",
	"email": "",
	"enabled": false,
	"hasPassword": false,
	"id": "",
	"level": 0,
	"organizationIds": [],
	"password": "",
	"phoneNumber": "",
	"realName": "",
	"remark": "",
	"roleIds": [],
	"roles": [
		{
			"roleId": "",
			"roleName": ""
		}
	],
	"tbUser": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userStatusEnum": "",
	"username": ""
}

getGroupUserByGroupId（待翻译）

接口地址:/api/yt/user/get_group_user/{groupId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
groupId groupId path true string

响应参数:

参数名称 参数说明 类型
accountExpireTime 账号失效时间 string(date-time)
activateToken 激活token string
avatar 头像 string
createTime 创建时间 string(date-time)
creator 创建用户 string
customerId 客户ID string
email 邮箱 string
enabled 账号状态 boolean
hasPassword 是否已重置密码 boolean
id ID string
level 角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号 integer(int32)
organizationIds 所辖组织ids array
password 密码 string
phoneNumber 电话号码 string
realName 真实名称 string
remark 备注 string
roleIds 角色ids array
roles 角色信息列表 array
  roleId 角色ID string
  roleName 角色名称 string
tbUser TB的UserId string
tenantId 租户ID string
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userStatusEnum 用户状态,可用值:DISABLED,EXPIRED,NORMAL string
username 用户名 string

响应示例:

[
	{
		"accountExpireTime": "",
		"activateToken": "",
		"avatar": "",
		"createTime": "",
		"creator": "",
		"customerId": "",
		"email": "",
		"enabled": false,
		"hasPassword": false,
		"id": "",
		"level": 0,
		"organizationIds": [],
		"password": "",
		"phoneNumber": "",
		"realName": "",
		"remark": "",
		"roleIds": [],
		"roles": [
			{
				"roleId": "",
				"roleName": ""
			}
		],
		"tbUser": "",
		"tenantId": "",
		"tenantName": "",
		"updateTime": "",
		"updater": "",
		"userStatusEnum": "",
		"username": ""
	}
]

getUserRoleOrGroup（待翻译）

接口地址:/api/yt/user/relation

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": "",
  "queryOrganization": true,
  "queryRole": true,
  "userId": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
roleOrOrganizationReqDTO RoleOrOrganizationReqDTO body true RoleOrOrganizationReqDTO

响应参数:

参数名称 参数说明 类型
errorCode Platform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden) object
message Error message string
status HTTP Response Status Code integer(int32)
timestamp Timestamp string(date-time)

响应示例:

[
	{
]
1
https://gitee.com/thingskit/thingskit-docs.git
git@gitee.com:thingskit/thingskit-docs.git
thingskit
thingskit-docs
ThingsKit物联网平台文档
master
点此查找更多帮助

搜索帮助

Git 命令在线学习 如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部