ThingsKit物联网平台API文档-租户管理（租户角色）

租户角色新增和编辑

接口地址:/api/yt/role/save_with_menu

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "id": "",
  "menu": [],
  "name": "",
  "remark": "",
  "roleType": "",
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
roleReqDTO	RoleReqDTO	body	true	RoleReqDTO
id			false	string
menu			false	array
name			false	string
remark			false	string
roleType	可用值:CUSTOMER_USER,PLATFORM_ADMIN,SYS_ADMIN,TENANT_ADMIN		false	string
status			false	integer(int32)

响应参数:

参数名称	参数说明	类型
code	角色Code	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
icon	租户图标	string
id	ID	string
name	角色名称	string
remark	备注	string
roleIds	角色ID列表	array
roleType	角色类型	string
status	状态	boolean
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"code": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"icon": "",
	"id": "",
	"name": "",
	"remark": "",
	"roleIds": [],
	"roleType": "",
	"status": false,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

启用禁用角色状态

接口地址:/api/yt/role/update_status/{roleId}/{status}

请求方式:PUT

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
roleId	roleId	path	true	string
status	status	path	true	integer(int32)

删除租户角色(待翻译)

接口地址:/api/yt/role

请求方式:DELETE

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
strings	string	body	true	array

响应参数:

参数名称	参数说明	类型	schema
errorCode	Platform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – 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)	integer(int32)
timestamp	Timestamp	string(date-time)	string(date-time)

角色分页

接口地址:/api/yt/role{?orderFiled,orderType,page,pageSize,roleName,status}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	是否必须	数据类型
page	page	true	int
pageSize	pageSize	true	int
roleName	roleName	false	string
status	status	false	integer(int32)
orderFiled	orderFiled	false	string
orderType	orderType,可用值:ASC,DESC	false	string

响应参数:

参数名称	参数说明	类型
items		array
code	角色Code	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
icon	租户图标	string
id	ID	string
name	角色名称	string
remark	备注	string
roleIds	角色ID列表	array
roleType	角色类型	string
status	状态	boolean
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"code": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"icon": "",
			"id": "",
			"name": "",
			"remark": "",
			"roleIds": [],
			"roleType": "",
			"status": false,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}