认证中心

CompanyRestApi

com.magus.cloud.auth.api.CompanyRestApi

delete

接口说明

批量删除租户

请求地址

POST /magus-auth/auth/comps/delete

请求参数

参数名	父级	类型	是否必须	示例值	描述
ids		Array	1	["015fccff-f675-4d40-b76f-3e814c544328"]	租户id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

["015fccff-f675-4d40-b76f-3e814c544328", "134b9feb-cd37-4e60-a67c-f431d6ea1a84"]

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true
}

findById

接口说明

根据id查询租户

请求地址

GET /magus-auth/auth/comps/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1	015fccff-f675-4d40-b76f-3e814c544328	租户id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	Id
name	data	String	租户名称
showName	data	String	展示名称
logo	data	String	左上角logo
code	data	String	租户编码
disable	data	Boolean	开启/禁用;0=开启;1=禁用
remark	data	String	说明
deleteFlag	data	Boolean	是否删除

请求示例

["015fccff-f675-4d40-b76f-3e814c544328", "134b9feb-cd37-4e60-a67c-f431d6ea1a84"]

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "name": "",
    "showName": "",
    "logo": "",
    "code": "",
    "disable": false,
    "remark": "",
    "deleteFlag": false
  }
}

findByCode

接口说明

根据code查询租户

请求地址

GET /magus-auth/auth/comps/find-by-code

请求参数

参数名	父级	类型	是否必须	示例值	描述
code		String	1	Magustek	租户编码

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	Id
name	data	String	租户名称
showName	data	String	展示名称
logo	data	String	左上角logo
code	data	String	租户编码
disable	data	Boolean	开启/禁用;0=开启;1=禁用
remark	data	String	说明
deleteFlag	data	Boolean	是否删除

请求示例

["magustek", "alibaba"]

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "name": "",
    "showName": "",
    "logo": "",
    "code": "",
    "disable": false,
    "remark": "",
    "deleteFlag": false
  }
}

list

接口说明

查询所有租户

请求地址

GET /magus-auth/auth/comps/list

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	listlist	String	Id
name	list	String	租户名称
showName	list	String	展示名称
logo	list	String	左上角logo
code	list	String	租户编码
disable	list	Boolean	开启/禁用;0=开启;1=禁用
remark	list	String	说明
deleteFlag	list	Boolean	是否删除

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "name": "",
      "showName": "",
      "logo": "",
      "code": "",
      "disable": false,
      "remark": "",
      "deleteFlag": false
    }
  ]
}

page

接口说明

租户分页

请求地址

POST /magus-auth/auth/comps/page

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1		com.magus.cloud.auth.dto.req.CompSearchReq
name	req	String	0	麦杰	租户名
code	req	String	0	magustek	租户编码
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	create_date_by	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array	当前页结果集
id	list	String	Id
name	list	String	租户名称
showName	list	String	展示名称
logo	list	String	左上角logo
code	list	String	租户编码
disable	list	Boolean	开启/禁用;0=开启;1=禁用
remark	list	String	说明
deleteFlag	list	Boolean	是否删除

请求示例

{
  "name": "",
  "code": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"totalNum": 0,
	"totalPage": 0,
	"page": 0,
	"size": 0,
	"list": [
		{
      "id": "",
      "name": "",
      "showName": "",
      "logo": "",
      "code": "",
      "disable": false,
      "remark": "",
      "deleteFlag": false
    }
	]
}

upsert

接口说明

新建/更新租户

请求地址

POST /magus-auth/auth/comps/upsert

请求参数

参数名	父级	类型	是否必须	示例值	描述
data		Object	1		com.magus.cloud.auth.dto.req.CompanyReq
name	data	String	1	麦杰	租户名称
showName	data	String	0	magustek	展示名称
logo	data	String	0	677161fb-0f62-4a7f-9931-eea6df279759	左上角logo文件id
code	data	String	1	magustek	租户编码
disable	data	Boolean	0	0	开启/禁用;0=开启;1=禁用
remark	data	String	0	上海麦杰	说明

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	Id
name	data	String	租户名称
showName	data	String	展示名称
logo	data	String	左上角logo
code	data	String	租户编码
disable	data	Boolean	开启/禁用;0=开启;1=禁用
remark	data	String	说明
deleteFlag	data	Boolean	是否删除

请求示例

{
  "name": "",
  "showName": "",
  "logo": "",
  "code": "",
  "disable": false,
  "remark": ""
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "name": "",
    "showName": "",
    "logo": "",
    "code": "",
    "disable": false,
    "remark": "",
    "deleteFlag": false
  }
}

disable

接口说明

启用/禁用租户

请求地址

GET /magus-auth/auth/comps/disable/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
Id		String	1		租户ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

"015fccff-f675-4d40-b76f-3e814c544328"

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true
}

OrganizationRestApi

com.magus.cloud.auth.api.OrganizationRestApi

page

接口说明

组织分页

请求地址

POST /magus-auth/auth/orgs/page

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object			com.magus.cloud.auth.dto.req.OrganizationSearchReq
compId	req	String	0	c1ebdcfe-ba46-410b-b75b-df59d5f3b8e1	组织ID
parentId	req	String	0	c1ebdcfe-ba46-410b-b75b-df59d5f3b8e1	上级组织ID
code	req	String	0	TechDevelop	组织编码
name	req	String	0	技术研发部	组织名称
type	req	String	0	depart	组织类型
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	create_date_	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array	当前页结果集
id	list	String	主键
code	list	string	组织机构编码
name	list	string	组织名称
remark	list	array	组织说明
type	list	string	组织类型
sort	list	Integer	表单校验错误消息
parentId	list	String	上级组织id

请求示例

{
  "parentId": "",
  "compId": "",
  "code": "",
  "name": "",
  "type": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"totalNum": 0,
	"totalPage": 0,
	"page": 0,
	"size": 0,
	"list": [
		{
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
	]
}

save

接口说明

新建/更新组织

请求地址

POST /magus-auth/auth/orgs/save

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1		com.magus.cloud.auth.dto.req.CompanyReq
code	req	string	1	tech	组织编码
name	req	string	1	技术部	组织名称
remark	req	string	0	技术部	组织说明
type	req	string	0	depart	组织类型
sort	req	integer(int32)	0	0	排列序号
compId	req	string	0	c1ebdcfe-ba46-410b-b75b-df59d5f3b8e1	所属企业

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	result	String	主键
code	result	string	组织机构编码
name	result	string	组织名称
remark	result	array	组织说明
type	result	string	组织类型
sort	result	Integer	表单校验错误消息
parentId	result	String	上级组织id

请求示例

{
  "id": "",
  "code": "",
  "name": "",
  "remark": "",
  "type": "",
  "sort": 0,
  "compId": "",
  "parentId": ""
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "code": "",
    "name": "",
    "remark": "",
    "type": "",
    "sort": 0,
    "compId": "",
    "parentId": ""
  }
}

tree

接口说明

组织树结构

请求地址

GET /magus-auth/auth/orgs/tree

请求参数

参数名	父级	类型	是否必须	示例值	描述
Id		String	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
nodePid	data	string	上级
nodeId	data	string	节点id
entityId	data	string	实体类id
entityType	data	string
text	data	string	文本
icon	data	string
iconCls	data	string
checked	data	Boolean
expanded	data	Boolean
leaf	data	Boolean
extend	data	Object	扩展变量
children	data	Array	子级

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "nodePid": "",
    "nodeId": "",
    "entityId": "",
    "entityType": "",
    "text": "",
    "icon": "",
    "iconCls": "",
    "checked": false,
    "expanded": false,
    "leaf": false,
    "extend": {},
    "children": []
  }
}

findAll

接口说明

查询所有组织

请求地址

GET /magus-auth/auth/orgs/find-all

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	主键
code	list	string	组织机构编码
name	list	string	组织名称
remark	list	array	组织说明
type	list	string	组织类型
sort	list	Integer	表单校验错误消息
compId	list	String	租户id
parentId	list	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
  ]
}

findById

接口说明

根据ID查询组织

请求地址

GET /magus-auth/auth/orgs/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
Id		String	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	主键
code	data	string	组织机构编码
name	data	string	组织名称
remark	data	array	组织说明
type	data	string	组织类型
sort	data	Integer	表单校验错误消息
compId	data	String	租户id
parentId	data	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "code": "",
    "name": "",
    "remark": "",
    "type": "",
    "sort": 0,
    "compId": "",
    "parentId": ""
  }
}

findAllById

接口说明

根据ID批量查询组织

请求地址

POST /magus-auth/auth/orgs/find-all-by-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
orgIds		Array	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	主键
code	list	string	组织机构编码
name	list	string	组织名称
remark	list	array	组织说明
type	list	string	组织类型
sort	list	Integer	表单校验错误消息
compId	list	String	租户id
parentId	list	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
  ]
}

findTopOrganization

接口说明

查询顶级组织

请求地址

POST /magus-auth/auth/orgs/find-top-org

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	主键
code	data	string	组织机构编码
name	data	string	组织名称
remark	data	array	组织说明
type	data	string	组织类型
sort	data	Integer	表单校验错误消息
compId	data	String	租户id
parentId	data	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "code": "",
    "name": "",
    "remark": "",
    "type": "",
    "sort": 0,
    "compId": "",
    "parentId": ""
  }
}

delete

接口说明

批量删除组织

请求地址

POST /magus-auth/auth/orgs/delete

请求参数

参数名	父级	类型	是否必须	示例值	描述
ids		Array	1		组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true
}

findCompanyByCode

接口说明

根据编码查询组织

请求地址

GET /magus-auth/auth/orgs/find-company

请求参数

参数名	父级	类型	是否必须	示例值	描述
code		String	1		公司编码

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	主键
code	data	string	组织机构编码
name	data	string	组织名称
remark	data	array	组织说明
type	data	string	组织类型
sort	data	Integer	表单校验错误消息
compId	data	String	租户id
parentId	data	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "code": "",
    "name": "",
    "remark": "",
    "type": "",
    "sort": 0,
    "compId": "",
    "parentId": ""
  }
}

findByCodeIn

接口说明

根据code批量查询组织

请求地址

POST /magus-auth/auth/orgs/find-by-code-in

请求参数

参数名	父级	类型	是否必须	示例值	描述
Codes		Array	1		组织code

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	主键
code	list	string	组织机构编码
name	list	string	组织名称
remark	list	array	组织说明
type	list	string	组织类型
sort	list	Integer	表单校验错误消息
compId	list	String	租户id
parentId	list	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
  ]
}

findByParentIdIn

接口说明

根据上级组织ID批量查询组织

请求地址

POST /magus-auth/auth/orgs/find-by-parent-in

请求参数

参数名	父级	类型	是否必须	示例值	描述
parentIds		Array	1		上级组织id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	主键
code	list	string	组织机构编码
name	list	string	组织名称
remark	list	array	组织说明
type	list	string	组织类型
sort	list	Integer	表单校验错误消息
compId	list	String	租户id
parentId	list	String	上级组织id

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "code": "",
      "name": "",
      "remark": "",
      "type": "",
      "sort": 0,
      "compId": "",
      "parentId": ""
    }
  ]
}

UserRestApi

com.magus.cloud.auth.api.UserRestApi

page

接口说明

用户分页

请求地址

POST /magus-auth/auth/users/page

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object			com.magus.cloud.auth.dto.req.UserSearchReq
compCode	req	String	0	magustek	租户code
orgId	req	String	0	c1ebdcfe-ba46-410b-b75b-df59d5f3b8e1	组织ID
userName	req	String	0	张三	用户名称
loginId	req	String	0	zhangsan	用户编码
loginIds	req	Array	0	["zhangsan"]	编码集合
ids	req	Array	0		用户ID
loginIdsNotIn	req	Array	0		不包含的用户集合
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	create_date_	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array	当前页结果集
id	list	string	用户Id
userName	list	string	用户名
loginId	list	string	登录ID
passwordLastModified	list		密码修改时间
endDate	list	integer(int64)	密码失效日期
authMode	list	string	认证模式:local 本地认证, AD windows域认证
state	list	string	用户状态 normal:正常; locked:锁定
stateDesc	list		用户状态 normal:正常; locked:锁定
profile	list	string	用户头像
phone	list	string	手机号
email	list	string	邮箱
remark	list	string	备注
compName	list	string	租户名
compCode	list	array	租户code
compShowName	list		租户展示名
compLogo	list		租户logo
positionId	list	string	职位ID
formalFlag	list	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	list	string	组织Id
orgCode	list		组织机构编码
orgName	list		组织机构名
dutyId	list	string	职务Id
wechat	list	String	wechat
dingtalk	list	String	钉钉
formalFlag	list	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	list	Date	创建时间
modifyPassword	list	Boolean	是否需要修改密码
systemAdmin	list	Boolean	是否超级用户
admin	list	Boolean	是否管理员

请求示例

{
  "compCode": "",
  "orgId": "",
  "userName": "",
  "loginId": "",
  "loginIds": [
    ""
  ],
  "ids": [
    ""
  ],
  "loginIdsNotIn": [
    ""
  ],
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"totalNum": 0,
	"totalPage": 0,
	"page": 0,
	"size": 0,
	"list": [
		{
      "id": "",
      "userName": "",
      "loginId": "",
      "passwordLastModified": "2023-11-22 09:08:03",
      "endDate": 0,
      "authMode": "",
      "state": "",
      "stateDesc": "",
      "profile": "",
      "phone": "",
      "email": "",
      "remark": "",
      "compId": "",
      "compCode": "",
      "compName": "",
      "compShowName": "",
      "compLogo": "",
      "orgId": "",
      "orgCode": "",
      "orgName": "",
      "wechat": "",
      "dingtalk": "",
      "positionId": "",
      "dutyId": "",
      "formalFlag": false,
      "createDate": "2023-11-22 09:08:03",
      "modifyPassword": false,
      "systemAdmin": false,
      "admin": false
    }
	]
}

findById

接口说明

根据id查询用户

请求地址

GET /magus-auth/auth/users/find-by-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1		用户id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
Data		Object
id	data	string	用户Id
userName	data	string	用户名
loginId	data	string	登录ID
passwordLastModified	data		密码修改时间
endDate	data	integer(int64)	密码失效日期
salt	data	string	加密密码的盐
authMode	data	string	认证模式:local 本地认证, AD windows域认证
state	data	string	用户状态 normal:正常; locked:锁定
stateDesc	data		用户状态 normal:正常; locked:锁定
profile	data	string	用户头像
phone	data	string	手机号
email	data	string	邮箱
remark	data	string	备注
compName	data	string	租户名
compCode	data	array	租户code
compShowName	data		租户展示名
compLogo	data		租户logo
positionId	data	string	职位ID
formalFlag	data	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	data	string	组织Id
orgCode	data		组织机构编码
orgName	data		组织机构名
dutyId	data	string	职务Id
wechat	data	String	wechat
dingtalk	data	String	钉钉
formalFlag	data	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	data	Date	创建时间
modifyPassword	data	Boolean	是否需要修改密码
systemAdmin	data	Boolean	是否超级用户
admin	data	Boolean	是否管理员

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "userName": "",
    "loginId": "",
    "passwordLastModified": "2023-11-22 09:08:03",
    "endDate": 0,
    "authMode": "",
    "state": "",
    "stateDesc": "",
    "profile": "",
    "phone": "",
    "email": "",
    "remark": "",
    "compId": "",
    "compCode": "",
    "compName": "",
    "compShowName": "",
    "compLogo": "",
    "orgId": "",
    "orgCode": "",
    "orgName": "",
    "wechat": "",
    "dingtalk": "",
    "positionId": "",
    "dutyId": "",
    "formalFlag": false,
    "createDate": "2023-11-22 09:08:03",
    "modifyPassword": false,
    "systemAdmin": false,
    "admin": false
  }
}

findByLoginId

接口说明

根据Loginid查询用户

请求地址

GET /magus-auth/auth/users/find-by-login-id

请求参数

参数名	父级	类型	是否必须	示例值	描述
loginId		String	1		用户Loginid

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
Data		Object
id	data	string	用户Id
userName	data	string	用户名
loginId	data	string	登录ID
passwordLastModified	data		密码修改时间
endDate	data	integer(int64)	密码失效日期
salt	data	string	加密密码的盐
authMode	data	string	认证模式:local 本地认证, AD windows域认证
state	data	string	用户状态 normal:正常; locked:锁定
stateDesc	data		用户状态 normal:正常; locked:锁定
profile	data	string	用户头像
phone	data	string	手机号
email	data	string	邮箱
remark	data	string	备注
compName	data	string	租户名
compCode	data	array	租户code
compShowName	data		租户展示名
compLogo	data		租户logo
positionId	data	string	职位ID
formalFlag	data	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	data	string	组织Id
orgCode	data		组织机构编码
orgName	data		组织机构名
dutyId	data	string	职务Id
wechat	data	String	wechat
dingtalk	data	String	钉钉
formalFlag	data	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	data	Date	创建时间
modifyPassword	data	Boolean	是否需要修改密码
systemAdmin	data	Boolean	是否超级用户
admin	data	Boolean	是否管理员

请求示例

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"data": {
    "id": "",
    "userName": "",
    "loginId": "",
    "passwordLastModified": "2023-11-22 09:08:03",
    "endDate": 0,
    "authMode": "",
    "state": "",
    "stateDesc": "",
    "profile": "",
    "phone": "",
    "email": "",
    "remark": "",
    "compId": "",
    "compCode": "",
    "compName": "",
    "compShowName": "",
    "compLogo": "",
    "orgId": "",
    "orgCode": "",
    "orgName": "",
    "wechat": "",
    "dingtalk": "",
    "positionId": "",
    "dutyId": "",
    "formalFlag": false,
    "createDate": "2023-11-22 09:08:03",
    "modifyPassword": false,
    "systemAdmin": false,
    "admin": false
  }
}

list

接口说明

查询用户

请求地址

POST /magus-auth/auth/users/list

请求参数

参数名	类型	描述
companyId	String	租户id
companyCode	String	租户code
ids	Array	用户id
loginIds	Array	用户loginId
orgIds	Array	组织id
positionIds	Array	职位id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
List		Array
id	list	string	用户Id
userName	list	string	用户名
loginId	list	string	登录ID
passwordLastModified	list		密码修改时间
endDate	list	integer(int64)	密码失效日期
salt	list	string	加密密码的盐
authMode	list	string	认证模式:local 本地认证, AD windows域认证
state	list	string	用户状态 normal:正常; locked:锁定
stateDesc	list	String	用户状态 normal:正常; locked:锁定
profile	list	string	用户头像
phone	list	string	手机号
email	list	string	邮箱
remark	list	string	备注
compName	list	string	租户名
compCode	list	array	租户code
compShowName	list	String	租户展示名
compLogo	list	String	租户logo
positionId	list	string	职位ID
formalFlag	list	boolean	是否实体用户 0=临时用户;1=正式用户
orgId	list	string	组织Id
orgCode	list	String	组织机构编码
orgName	list	String	组织机构名
dutyId	list	string	职务Id
wechat	list	String	wechat
dingtalk	list	String	钉钉
formalFlag	list	Boolean	是否实体用户 0=临时用户;1=正式用户
createDate	list	Date	创建时间
modifyPassword	list	Boolean	是否需要修改密码
systemAdmin	list	Boolean	是否超级用户
admin	list	Boolean	是否管理员

请求示例

{
  "companyId": "",
  "companyCode": "",
  "ids": [
    ""
  ],
  "loginIds": [
    ""
  ],
  "orgIds": [
    ""
  ],
  "positionIds": [
    ""
  ]
}

响应示例

{
	"result": {
		"bizCode": 0,
		"resultCode": "",
		"message": "",
		"validResults": [
			{
				"propertyPath": "",
				"message": ""
			}
		]
	},
	"rspFlag": true,
	"list": [
    {
      "id": "",
      "userName": "",
      "loginId": "",
      "passwordLastModified": "2023-11-22 09:08:03",
      "endDate": 0,
      "authMode": "",
      "state": "",
      "stateDesc": "",
      "profile": "",
      "phone": "",
      "email": "",
      "remark": "",
      "compId": "",
      "compCode": "",
      "compName": "",
      "compShowName": "",
      "compLogo": "",
      "orgId": "",
      "orgCode": "",
      "orgName": "",
      "wechat": "",
      "dingtalk": "",
      "positionId": "",
      "dutyId": "",
      "formalFlag": false,
      "createDate": "2023-11-22 09:08:03",
      "modifyPassword": false,
      "systemAdmin": false,
      "admin": false
    }
  ]
}

认证中心 ​

CompanyRestApi ​

delete ​

findById ​

findByCode ​

list ​

page ​

upsert ​

disable ​

OrganizationRestApi ​

page ​

save ​

tree ​

findAll ​

findById ​

findAllById ​

findTopOrganization ​

delete ​

findCompanyByCode ​

findByCodeIn ​

findByParentIdIn ​

UserRestApi ​

page ​

findById ​

findByLoginId ​

list ​

认证中心

CompanyRestApi

delete

findById

findByCode

list

page

upsert

disable

OrganizationRestApi

page

save

tree

findAll

findById

findAllById

findTopOrganization

delete

findCompanyByCode

findByCodeIn

findByParentIdIn

UserRestApi

page

findById

findByLoginId

list