支持地域：上海

用户权限 API

简介:用户权限管理API

HOST:https://{envId}.ap-shanghai.tcb-api.tencentcloudapi.com

管理用户

创建用户

接口地址:/weda/auth/v1.1/{envType}/addUser

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

创建weda用户

请求示例:

{
 "Name": "User1",
 "NickName": "UserNickName",
 "Uuid": "22332323",
 "Phone": "13709999999",
 "Email": "1234567@qq.com",
 "Password": "TestUser1",
 "ParentUserId":"1688747135862595586",
 "RoleIds": [
 "160483621866285465",
 "160483621866285464"
 ],
 "MainOrg": {
 "OrgId": "630e01e284ae3f3f6abff2f05NSXH23BPE",
 "OrgIdentity": ""
 },
 "Description": "",
 "UserExtend": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
创建用户对象		body	true	创建用户对象
Name	用户名; 格式：用户名只能以字母或数字开头，长度在1-64位之间用户名只能包含大小写英文字母、数字和符号 - _ . @		true	string
NickName	用户昵称;格式：2-64位的字符串		false	string
Phone	手机号;格式正确且不能重复		false	string
Email	邮箱;格式正确且不能重复		false	string
Uuid	客户系统用户id;不能重复,不传则由系统生成备注：用于开发者已有用户系统的情况下，建议传入自己系统的用户id		false	string
Password	密码;格式：4-60位字符串; 备注：Uuid和Password不能同时为空		false	string
ParentUserId	直属上级用户id; 备注：weda用户id		false	string
RoleIds	角色id列表		false	array	string
MainOrg	主岗部门		false	部门对象
OrgId	部门id		true	string
OrgIdentity	部门标识		false	string
Description	用户描述		false	string
UserExtend	用户数据源扩展信息，json串		false	string
Sort	权重;用于用户排序		false	integer

响应状态:

状态码	说明	schema
200	OK	ServerResponse

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象	公共出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	用户id	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": "160483621866285465"
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

删除用户

接口地址:/weda/auth/v1.1/{envType}/deleteUser

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "UserIdList": [
 "160483621866285465"
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
删除用户入参对象		body	true		删除用户入参对象
UserIdList	weda用户id(传入一个weda用户id即可，只支持单个删除)		true	array	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	是否成功	boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

更新用户

接口地址:/weda/auth/v1.1/{envType}/updateUserInfoByUserId

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "UserId": "1519289370670850049",
 "Name": "User1",
 "NickName": "UserNickName",
 "Phone": "13709999999",
 "Email": "1234567@qq.com",
 "Password": "TestUser1",
 "ParentUserId":"1688747135862595586",
 "RoleIds": [
 "160483621866285465",
 "160483621866285464"
 ],
 "MainOrg": {
 "OrgId": "630e01e284ae3f3f6abff2f05NSXH23BPE",
 "OrgIdentity": ""
 },
 "Description": "",
 "UserExtend": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
更新用户对象		body	true	更新用户对象
UserId	weda用户id		true	string
Name	用户名; 格式：用户名只能以字母或数字开头，长度在1-64位之间用户名只能包含大小写英文字母、数字和符号 - _ . @ 备注：传空字符串，不传此参数或者传null都表示不修改		false	string
NickName	用户昵称; 格式：2-64位的字符串; 备注：传空字符串会修改为空，不传此参数或者传null则不修改		false	string
Phone	手机号; 备注：传空字符串会修改为空，不传此参数或传null则不修改		false	string
Email	邮箱; 备注：传空字符串会修改为空，不传此参数或传null则不修改		false	string
Password	密码; 格式：4-60位字符串; 备注：传空字符串,不传此参数或传null都表示不修改		false	string
ParentUserId	直属上级用户id; 备注：不传此参数或传null都表示不修改		false	string
RoleIds	角色id列表; 备注：不传此参数,传null或者传入空数组都表示不修改角色		false	array	string
MainOrg	主岗部门; 备注：不传此参数,传null或者空对象都会清空主岗部门		false	部门对象
OrgId	部门id		true	string
OrgIdentity	部门标识		false	string
Description	用户描述; 备注：传空字符串会修改为空，不传此参数或传null则不修改		false	string
UserExtend	用户数据源扩展信息，json串; 备注：传空字符串，不传此参数或者传null都表示不修改		false	string
Sort	权重;用于用户排序备注：不传此参数或传null则不修改		false	integer

响应状态:

状态码	说明	schema
200	OK	ServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	是否成功	boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

用户详情

接口地址:/weda/auth/v1.1/{envType}/describeWedaUser

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "UserId": "151928937067085004",
 "RelatedType": "UserRelatedRole"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
查询用户入参对象	查询用户入参对象	body	true	查询用户入参对象	查询用户入参对象
UserId	weda用户id		true	string
RelatedType	是否需要返回关联角色；备注：不传当前参数默认不返回，需要返回角色传入：UserRelatedRole		false	string
WithIdentities	是否获取 IdP Token 信息		false	boolean

响应状态:

状态码	说明	schema
200	OK	ServerResponse用户出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为用户出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
Data	用户列表	用户出参对象	用户出参对象
Name	名称	string
Type	用户类型 0:内部用户，1:外部用户，2:匿名用户	integer
InternalUserType	内部用户类型 1：超级管理员；0：自建用户	integer
Source	来源 1: 自建用户 2: 企微 3: 外部用户	integer
NickName	昵称	string
Email	邮箱	string
Phone	手机号	string
RelatedRoles	关联角色	array	角色详情对象
Name	角色名称	string
RoleIdentity	角色标识	string
Id	角色id	string
RoleDesc	角色描述	string
IsReleased	是否发布	boolean
UserDesc	用户描述	string
UserId	用户id	string
UserExtend	用户数据源扩展信息，json串	string
MainOrg	主岗部门	部门对象	部门对象
OrgId	部门id	string
OrgIdentity	部门标识	string
Identities	外部身份源	array
Provider	身份源 ID	string
AccessToken	在外部身份源中的 Access Token	string
RefreshToken	在外部身份源中的 Refresh Token	string

响应示例:

{
 "Response":{
 "RequestId":"",
 "Error":{
 "code":"",
 "message":""
 },
 "Data":{
 "Name":"User1",
 "Type":0,
 "InternalUserType":0,
 "Source":0,
 "NickName":"UserNickName",
 "Email":"",
 "Phone":"",
 "RelatedRoles":[
 {
 "Name":"角色名称",
 "RoleIdentity":"RoleIdentity",
 "Id":"123213",
 "RoleDesc":"",
 "IsReleased":true
 }
 ],
 "UserDesc":"",
 "UserId":"160483621866285465",
 "UserExtend":"",
 "MainOrg":{
 "OrgId":"",
 "OrgIdentity":""
 },
 "Identities":[
 {
 "Provider":"",
 "AccessToken":"",
 "RefreshToken":""
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

用户列表

接口地址:/weda/auth/v1.1/{envType}/describeUserList

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "PageNo": 1,
 "PageSize": 10
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
查询用户列表入参对象	查询用户列表入参对象	body	true	查询用户列表入参对象	查询用户列表入参对象
PageNo	页码，默认为1		false	integer(int32)
PageSize	每页数目，默认为100		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ServerResponse查询用户出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		查询用户出参对象	查询用户出参对象
Total	总数	integer
UserList	用户列表	array	用户出参对象
Name	名称	string
Type	用户类型 0:内部用户，1:外部用户，2:匿名用户	integer
InternalUserType	内部用户类型 1：超级管理员；0：自建用户	integer
Source	来源	integer
NickName	昵称	string
Email	邮箱	string
Phone	手机号	string
RelatedRoles	关联角色	array	角色详情对象
Name	角色名称	string
RoleIdentity	角色标识	string
Id	角色id	string
RoleDesc	角色描述	string
IsReleased	是否发布	boolean
UserDesc	用户描述	string
UserId	用户id	string
UserExtend	用户数据源扩展信息，json串	string
MainOrg	主岗部门	部门对象	部门对象
OrgId	部门id	string
OrgIdentity	部门标识	string
OrgName	部门名称	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Total": 1,
 "UserList": [
 {
 "Name": "User1",
 "Type": 0,
 "InternalUserType": 0,
 "Source": 0,
 "NickName": "UserNickName",
 "Email": "",
 "Phone": "",
 "RelatedRoles": [
 {
 "Name": "角色名称",
 "RoleIdentity": "RoleIdentity",
 "Id": "12312312312312321",
 "RoleDesc": "",
 "IsReleased": true
 }
 ],
 "UserDesc": "",
 "UserId": "160483621866285465",
 "UserExtend": "",
 "MainOrg": {
 "OrgId": "",
 "OrgIdentity": "",
 "OrgName": ""
 }
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

批量新增用户

接口地址:/weda/auth/v1/prod/batchAddUsers

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

批量新增用户，混合云暂不支持此接口

请求示例:

{
 "users": [
 {
 "name": "test_88888_0",
 "nickName": "1234",
 "password": "1234",
 "phone": "137204980",
 "email": "1205218880@qq.com",
 "uuid": "test_88888_0",
 "roleIds": [
 "1691342526177378305"
 ],
 "description": "test_88888_0",
 "userExtend": "{\"test\": \"userExtend\"}",
 "mainOrg": {
 "orgId": "4ebb756064db211001025a72017482fd"
 },
 "orgs": [
 {
 "orgId": "4ebb756064db216a01025c7057c98bca"
 }
 ]
 },
 {
 "name": "test_88888_1",
 "nickName": "1234",
 "password": "1234",
 "phone": "137204981",
 "email": "1205218881@qq.com",
 "uuid": "test_88888_1",
 "roleIds": [
 "1691342526177378305"
 ],
 "description": "test_88888_1",
 "userExtend": "{\"test\": \"userExtend\"}",
 "mainOrg": {
 "orgId": "4ebb756064db211001025a72017482fd"
 }
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
批量新增用户对象	批量新增用户对象	body	true
users	用户列表;单次新增用户数不能超过100		true	array
name	用户名; 格式：用户名只能以字母或数字开头，长度在1-64位之间用户名只能包含大小写英文字母、数字和符号 - _ . @		true	string
nickName	用户昵称;格式：2-64位的字符串		false	string
phone	手机号;格式正确且不能重复		false	string
email	邮箱;格式正确且不能重复		false	string
uuid	客户系统用户id;不能重复,不传则由系统生成备注：用于开发者已有用户系统的情况下，建议传入自己系统的用户id		false	string
password	密码;格式：4-60位字符串; 备注：Uuid和Password不能同时为空		false	string
parentUserId	直属上级用户id; 备注：weda用户id		false	string
roleIds	角色id列表		false	array	string
mainOrg	主岗部门		false	部门对象
orgId	部门id		true	string
orgIdentity	部门标识		false	string
description	用户描述		false	string
userExtend	用户数据源扩展信息，json串		false	string
sort	权重		false	integer

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse

响应参数:

参数名称	参数说明	类型	schema
response	公共出参对象	公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data			出参对象
users	用户列表	array	用户对象
userId	weda用户id	string
uuid	客户系统用户id;不传则由系统生成		false
name	用户名		true
nickName	用户昵称		false
phone	手机号		false
email	邮箱		false
parentUserId	直属上级用户id		false
roleIds	角色id列表		false
mainOrg	主岗部门		false
orgId	部门id		true
orgIdentity	部门标识		false
description	用户描述		false
userExtend	用户数据源扩展信息，json串		false
sort	权重	integer

响应示例:

{
 "response": {
 "requestId": "bca4ad8de89cb",
 "data": {
 "users": [
 {
 "userId": "1693458933143285761",
 "uuid": "1693458933143285761",
 "name": "test_88888_0",
 "nickName": "1234",
 "phone": "137204980",
 "email": "1205218880@qq.com",
 "roleIds": [
 "1691342526177378305"
 ],
 "description": "test_88888_0",
 "userExtend": "{\"test\": \"userExtend\"}",
 "mainOrg": {
 "orgId": "4ebb756064db211001025a72017482fd"
 },
 "appId": 1307578329,
 "internalUserType": 0
 },
 {
 "userId": "1693458933143285762",
 "uuid": "1693458933143285762",
 "name": "test_88888_1",
 "nickName": "1234",
 "phone": "137204981",
 "email": "1205218881@qq.com",
 "roleIds": [
 "1691342526177378305"
 ],
 "description": "test_88888_1",
 "userExtend": "{\"test\": \"userExtend\"}",
 "mainOrg": {
 "orgId": "4ebb756064db211001025a72017482fd"
 },
 "appId": 1307578329,
 "internalUserType": 0
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

触发同步任务

接口地址:/weda/auth/v1/{envType}/syncContacts

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "EnvId": "lowcode-5gnlujgs9e0f4844"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
触发同步任务入参对象	触发同步任务入参对象	body	true	触发同步任务入参对象	触发同步任务入参对象
EnvId	环境id		false	string

响应状态:

状态码	说明	schema
200	OK	ServerResponse触发同步任务出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为触发同步任务出参对象	公共出参对象，data类型为触发同步任务出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		触发同步任务出参对象	触发同步任务出参对象
Response		触发同步任务详情对象	触发同步任务详情对象
ExpiresIn	有效期	integer
SyncTaskId	同步任务Id	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Response": {
 "ExpiresIn": 0,
 "SyncTaskId": "3aa51821-2c45-40c8-a2f3-2bfd32a75c1e"
 }
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

查询同步任务状态

接口地址:/weda/auth/v1/{envType}/getSyncStatus

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "EnvId": "lowcode-5gnlujgs9e0f4844"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
查询同步任务状态入参对象	查询同步任务状态入参对象	body	true	查询同步任务状态入参对象	查询同步任务状态入参对象
EnvId	环境id		false	string

响应状态:

状态码	说明	schema
200	OK	ServerResponse查询同步任务状态出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为查询同步任务状态出参对象	公共出参对象，data类型为查询同步任务状态出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		查询同步任务状态出参对象	查询同步任务状态出参对象
Response		任务状态详情对象	任务状态详情对象
Status	任务状态，可选：PENDING（排队中），RUNNING（进行中），FINISH（完成)，ERROR(失败)	string
UserCount	同步用户数量，注意：此字段可能返回 null，表示取不到有效值。	integer
DepartCount	同步部门数量，注意：此字段可能返回 null，表示取不到有效值。	integer
TagCount	同步标签数量，注意：此字段可能返回 null，表示取不到有效值。	integer
LicensedUserCount	已授权人数，注意：此字段可能返回 null，表示取不到有效值。	integer
UnLicensedUserCount	未授权人数，注意：此字段可能返回 null，表示取不到有效值。	integer
ErrorMsg	失败原因	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Response": {
 "Status": "FINISH",
 "UserCount": 0,
 "DepartCount": 0,
 "TagCount": 0,
 "LicensedUserCount": 0,
 "UnLicensedUserCount": 0,
 "ErrorMsg": ""
 }
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

授权、冻结用户license

接口地址:/weda/auth/v1/{envType}/batchOperateWedaUserLicense

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "GrantUserIdList": [
 "160483621866285465a"
 ],
 "FreezeUserIdList": [
 "160483621866285465a"
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
授权license入参对象	授权、冻结用户列表不能均为空	body	true	授权license入参对象	授权license入参对象
GrantUserIdList	授予license的userId列表		false	array	string
FreezeUserIdList	冻结license的userId列表		false	array	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

管理组织机构

创建组织机构

接口地址:/weda/auth/v1/{envType}/addOrg

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "OrgData": "{\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"\",\"info\":\"扩展字段值\"}"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
新增部门入参对象		body	true	新增部门入参对象	新增部门入参对象
OrgData	部门信息；格式：部门信息json字符串;包含以下参数： departmentCode部门标识，必填，不能重复，格式为1-64位的字符串并且只能包含英文字母、数字、下划线、'.'和'-'； departmentName部门名称，必填，格式为2-32位的字符串,只能包含英文字母、数字、下划线、'.'和'-'且只能以字母或中文开头； departmentParentCode上级部门标识，非必填，备注：上级部门的部门标识。部门数据模型扩展字段,可以存在多个,非必填。例如示例中的info字段，可以在新增部门同时为扩展字段赋值。示例：{\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"\",\"info\":\"扩展字段值\"}		true	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseString

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为String	公共出参对象，data类型为String
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	部门id，默认和部门标识一致	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": ""
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

更新组织机构

接口地址:/weda/auth/v1/{envType}/updateOrg

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

根据部门id更新信息

请求示例:

{
 "OrgData": "{\"_id\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"zbm_kfbm_parent\",\"info\":\"扩展字段值\"}"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
更新部门入参对象	更新部门入参对象	body	true
OrgData	部门信息；格式：部门信息json字符串;包含以下参数： _id部门id，必填；departmentName部门名称，非必填，不传则不更新；departmentParentCode上级部门标识，非必填，不传不更新。部门数据模型扩展字段,非必填,不传则不更新。例如示例中的info字段，可以在根据部门id更新扩展信息。示例：{\"_id\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"zbm_kfbm_parent\",\"info\":\"扩展字段值\"}		true	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseLong

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象	公共出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	updateNum	integer(int64)

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": 0
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

删除组织机构

接口地址:/weda/auth/v1/{envType}/deleteOrg

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "OrgId": "zbm_kfbm"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
删除部门入参对象	删除部门入参对象	body	true	删除部门入参对象	删除部门入参对象
OrgId	部门id，创建组织架构接口返回		true	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseLong

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为Long	公共出参对象，data类型为Long
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	deletedNum	integer(int64)

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": 0
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

组织机构列表

接口地址:/weda/auth/v1/{envType}/describeOrgs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "PageNo": 1,
 "PageSize": 10
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
PageNo	页码,默认为1	body	false	integer(int32)
PageSize	每页数目,默认为1000	body	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ServerResponse

响应参数:

参数名称	参数说明	类型
Response	公共出参对象	公共出参对象
RequestId	requestId	string
Error	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		部门列表
DataList	部门列表,参数值为json字符串 DataId和_id都表示部门id; 示例： ["DataId":"zbm_kfbm","DataRecord":"{\"_id\":\"zbm_kfbm\",\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"\"}"]	array
Total	总数	integer

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "DataList": [
 {
 "DataId": "zbm_kfbm",
 "DataRecord": "{\"_id\":\"zbm_kfbm\",\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"zbm_kfbm_parent\"}"
 }
 ],
 "Total": 1
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

设置部门负责人

接口地址:/weda/auth/v1/prod/setOrgPrincipal

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "orgId": "org_001",
 "userIdList": ["1666390158540275714","1666390231445803001"]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
设置部门负责人入参对象		body	true	设置部门负责人对象
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
orgId	部门id		true	string
userIdList	部门负责人weda用户id列表。全量更新，每次接口调用都使用传入的用户作为部门负责人，未传入会从部门负责人中删除。传空或者不传此参数，表示部门没有部门负责人		false	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	是否成功	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

管理角色

创建角色

接口地址:/weda/auth/v1/prod/createRole

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "roleName": "自定义角色名称",
 "roleIdentity": "zdyjsbs",
 "description": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
创建角色入参对象	创建角色入参对象	body	true	创建角色入参对象	创建角色入参对象
roleName	角色名称		true	string
roleIdentity	角色标识		true	string
description	描述		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseString

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为String	公共出参对象，data类型为String
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	角色id	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": "1680507332078"
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

更新角色

接口地址:/weda/auth/v1/prod/modifyRole

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "roleId": "1680507332078",
 "roleName": "自定义角色名称",
 "description": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
更新角色入参对象	更新角色入参对象	body	true	更新角色入参对象	更新角色入参对象
roleId	角色id,由创建用户接口返回		true	string
roleName	角色名称,不传则不更新		false	string
description	描述,不传则不更新		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	是否成功	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

删除角色

接口地址:/weda/auth/v1/prod/deleteRole

请求方式:DELETE

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
roleId	角色id	query	true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	是否成功	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

查询角色详情

接口地址:/weda/auth/v1/prod/describeRole

请求方式:GET

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
roleName	角色名称	query	true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse角色详情对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象	公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	关联角色	角色详情对象	角色详情对象
roleName	角色名称	string
roleIdentity	角色标识	string
roleId	角色id	string
description	角色描述	string
isReleased	是否发布	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "roleName": "角色名称",
 "roleIdentity": "RoleIdentity",
 "roleId": "1688855289721864193",
 "description": "",
 "isReleased": true
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

角色列表

接口地址:/weda/auth/v1.1/{envType}/describeRoleList

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "PageNo": 1,
 "PageSize": 10
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
角色列表入参对象	角色列表入参对象	body	true	角色列表入参对象	角色列表入参对象
PageNo	页码		false	integer(int32)
PageSize	每页数目		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ServerResponse角色列表出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为角色列表出参对象	公共出参对象，data类型为角色列表出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		角色列表出参对象	角色列表出参对象
Total	总数	integer
RoleList	关联角色	array	角色详情对象
Name	角色名称	string
RoleIdentity	角色标识	string
Id	角色id	string
RoleDesc	角色描述	string
IsReleased	是否发布	boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Total": 1,
 "RoleList": [
 {
 "Name": "角色名称",
 "RoleIdentity": "RoleIdentity",
 "Id": "1688855289721864193",
 "RoleDesc": "",
 "IsReleased": true
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

根据角色查询用户列表

接口地址:/weda/auth/v1/{envType}/describeUsersByRoleId

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "RoleId": "1680507332078",
 "PageNo": 1,
 "PageSize": 10
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
查询角色用户入参对象	查询角色用户入参对象	body	true	查询角色用户入参对象	查询角色用户入参对象
RoleId	角色id		true	string
PageNo	页码		false	integer(int32)
PageSize	每页数目		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ServerResponse查询用户出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为查询用户出参对象	公共出参对象，data类型为查询用户出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		查询用户出参对象	查询用户出参对象
Total	总数	integer
UserList	用户列表	array	用户出参对象
Name	名称	string
Type	用户类型，0:内部用户，1:外部用户，2:匿名用户	integer
InternalUserType	内部用户类型，1：超级管理员；0：自建用户	integer
Source	来源	integer
NickName	昵称	string
Email	邮箱	string
Phone	手机号	string
RelatedRoles	关联角色	array	角色详情对象
Name	角色名称	string
RoleIdentity	角色标识	string
Id	角色id	string
RoleDesc	角色描述	string
IsReleased	是否发布	boolean
UserDesc	用户描述	string
UserId	用户id	string
Orgs	主岗部门	array	部门对象
OrgId	部门id	string
OrgIdentity	部门标识	string
UserExtend	用户数据源扩展信息，json串	string
MainOrg	主岗部门	部门对象	部门对象
OrgId	部门id	string
OrgIdentity	部门标识	string

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Total": 1,
 "UserList": [
 {
 "Uin": "100021405902",
 "Name": "testUser",
 "EnvId": "lowcode-4gs26nnz095f6f4d",
 "Type": 0,
 "InternalUserType": 0,
 "Source": 1,
 "NickName": "test_user_9",
 "Email": "",
 "Phone": "",
 "RelatedRoles": [
 {
 "Name": "test",
 "RoleIdentity": "zsjs15",
 "Source": 1,
 "UpdateTime": "2023-08-08T18:19:42",
 "Id": "1688855289721864193",
 "RoleDesc": "描述123333",
 "EnvId": "lowcode-4gs26nnz095f6f4d"
 }
 ],
 "Uuid": "test_user_9",
 "UserDesc": "test_user_9",
 "UserId": "1668468556945092610",
 "UpdateTime": "2023-07-05T11:28:17.283",
 "UserExtend": ""
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

用户关联角色

接口地址:/weda/auth/v1/{envType}/batchAuthorize

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "AuthorizeParam": [
 {
 "UserId": "1668468556945092610",
 "RoleIds": ["1688855289721864193"]
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
关联用户入参对象	关联用户入参对象	body	true	关联用户入参对象	关联用户入参对象
AuthorizeParam	绑定参数		false	array	角色关联用户对象
UserId	weda用户id		true	string
RoleIds	角色id列表,覆盖式更新，不传或者空数组表示不绑定任何角色		false	array	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data	是否成功	boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

取消角色关联的用户

接口地址:/weda/auth/v1/prod/unbindRoleUsers

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "roleId": "1688855289721864193",
 "userIds": ["1668468556945092610"]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
取消角色关联用户入参对象	取消角色关联用户入参对象	body	true	取消角色关联用户入参对象	取消角色关联用户入参对象
roleId	角色Id		true	string
userIds	取消关联的用户Id列表		true	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data	是否成功	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

更新角色下授权的用户列表

接口地址:/weda/auth/v1/prod/updateRoleUsers

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
 "roleId":"1673888777029201921",
 "userIds":[
 "1696423988333817859",
 "1694893419890860034"
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
更新角色下授权的用户		body	true
roleId	角色id		true	string
userIds	授权的weda用户id列表		true	array	string

响应状态:

状态码	说明	schema
200	OK	Boolean

响应参数:

参数名称	参数说明	类型	schema
response
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

发布角色

接口地址:/weda/auth/v1/prod/releaseRole

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

该接口用于发布全部角色到正式环境，只要修改了角色信息，角色关联的成员或者角色绑定的权限，都必须通过该接口发布角色，才能在正式环境生效，可以通过查询角色详情接口或者微搭控制台查看角色发布状态。

请求参数:

空对象

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse发布角色出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象	公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		发布角色出参对象	发布角色出参对象
taskId	角色发布任务id	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "taskId": "79c83a32-38ef-429f-a8d4-82ee71086a00"
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

查询发布角色状态

接口地址:/weda/auth/v1/prod/describeReleaseStatus

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

根据发布角色任务id查询发布状态

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
taskId	角色发布任务id	query	true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse任务状态出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为任务状态出参对象	公共出参对象，data类型为任务状态出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		任务状态出参对象	任务状态出参对象
taskStatus	发布任务状态，取值：发布成功：SUCCESS，发布中：PENDING，发布失败：FAILED	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "taskStatus": "SUCCESS"
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

管理资源与权限

绑定角色资源权限

接口地址:/weda/auth/v1/prod/bindRoleResources

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

该接口用于给角色绑定应用，页面，数据模型，流程的资源权限

请求示例:

{
 "roleId": "1680507332078",
 "resourceType": "app",
 "resourceIds": [
 "app-vlpgih87"
 ],
 "rowPermissionParams": [
 {
 "rowPermissionScopeType": "all",
 "rowPermissionOperationType": "rw"
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
绑定和解绑角色权限入参对象	绑定和解绑角色权限入参对象	body	true	绑定和解绑角色权限入参对象	绑定和解绑角色权限入参对象
roleId	角色Id		true	string
resourceType	资源类型，参数取值：自定义应用：app，自定义应用页面：page，模型应用：modelApp，模型应用页面：modelAppPage，数据源行权限：dataSource，流程：flow，		true	string
resourceIds	资源唯一标志符，参数取值：自定义应用：应用id，自定义应用页面：应用id-页面id，模型应用：应用id，模型应用页面：应用id-页面id,数据源行权限：数据模型id，流程：流程标识，		true	array	string
rowPermissionParams	行权限		false	array	数据行权限对象
rowPermissionScopeType	范围类型,取值：全部数据:all，部门及下级部门数据:org，本人及下属数据:staff，本人数据:me		false	string
rowPermissionOperationType	取值：只读：r，读写：rw		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse绑定和解绑角色权限出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为绑定和解绑角色权限出参对象	公共出参对象，data类型为绑定和解绑角色权限出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		绑定和解绑角色权限出参对象	绑定和解绑角色权限出参对象
failResourceIds	失败列表，一般情况下都为空，如果返回失败数据，需要重试接口	array	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "failResourceIds": []
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

解绑角色资源权限

接口地址:/weda/auth/v1/prod/unbindRoleResources

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

该接口用于给角色解绑应用，页面，数据模型，流程的资源权限

请求示例:

{
 "roleId": "1680507332078",
 "resourceType": "app",
 "resourceIds": [
 "app-vlpgih87"
 ],
 "rowPermissionParams": [
 {
 "rowPermissionScopeType": "all",
 "rowPermissionOperationType": "rw"
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
绑定和解绑角色权限入参对象		body	true	绑定和解绑角色权限入参对象
roleId	角色Id		true	string
resourceType	资源类型，参数取值：自定义应用：app，自定义应用页面：page，模型应用：modelApp，模型应用页面：modelAppPage，数据源行权限：dataSource，流程：flow，		true	string
resourceIds	资源唯一标志符，参数取值：自定义应用：应用id，自定义应用页面：应用id-页面id，模型应用：应用id，模型应用页面：应用id-页面id,数据源行权限：数据模型id，流程：流程标识，		true	array	string
rowPermissionParams	行权限		false	array	数据行权限对象
rowPermissionScopeType	范围类型,取值：全部数据:all，部门及下级部门数据:org，本人及下属数据:staff，本人数据:me		false	string
rowPermissionOperationType	取值：只读：r，读写：rw		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse绑定和解绑角色权限出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象	公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		绑定和解绑角色权限出参对象	绑定和解绑角色权限出参对象
failResourceIds	失败列表，一般情况下都为空，如果返回失败数据，需要重试接口	array	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "failResourceIds": []
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

校验角色资源权限

接口地址:/weda/auth/v1/prod/checkRoleResource

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

该接口用于检查角色是否有应用，页面，流程的资源权限，查询数据模型的行权限

请求示例:

{
 "roleId": "1680507332078",
 "resourceType": "app",
 "resourceIds": [
 "app-vlpgih87"
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
校验权限对象		body	true	校验权限对象
roleId	角色Id		true	string
resourceType	资源类型，参数取值：自定义应用：app，自定义应用页面：page，模型应用：modelApp，模型应用页面：modelAppPage，数据源行权限：dataSource，流程：flow，		true	string
resourceIds	资源唯一标志符，参数取值：自定义应用：应用id，自定义应用页面：应用id-页面id，模型应用：应用id，模型应用页面：应用id-页面id,数据源行权限：数据模型id，流程：流程标识，		true	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseList校验角色权限出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象	公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		array	校验角色权限出参对象
roleId	角色Id	string
resourceType	资源类型	string
resourceId	资源唯一标志符	string
isAccess	是否有权限	boolean
rowPermissionParams	行权限	array	数据行权限对象
rowPermissionScopeType	范围类型,取值：全部数据:all，部门及下级部门数据:org，本人及下属数据:staff，本人数据:me		false
rowPermissionOperationType	取值：只读：r，读写：rw		false

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": [
 {
 "roleId": "1680507332078",
 "resourceType": "app",
 "resourceId": "app-vlpgih87",
 "isAccess": true,
 "rowPermissionParams": [
 {
 "rowPermissionScopeType": "all",
 "rowPermissionOperationType": "rw"
 }
 ]
 }
 ]
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

绑定APIs接口权限

接口地址:/weda/auth/v1/prod/bindMethodAuth

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "roleId": "1680507332078",
 "dataSourceId": "data-2WJ5tUFYY",
 "methodList": [
 {
 "methodName": "method_bq7ylr0smpo1c",
 "isAccess": true
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
接口权限入参对象	接口权限入参对象	body	true	接口权限入参对象	接口权限入参对象
roleId	角色Id		true	string
dataSourceId	APIs对应的数据源id		true	string
methodList	方法名称列表		true	array	方法权限
methodName	方法名称		false	string
isAccess	是否有使用权限		false	boolean

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

查询角色绑定的APIs接口权限

接口地址:/weda/auth/v1/prod/describeMethodAuth

请求方式:GET

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
roleId	角色id	query	true	string
dataSourceId	APIs对应的数据源id	query	true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse接口权限列表出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为接口权限列表出参对象	公共出参对象，data类型为接口权限列表出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		接口权限列表出参对象	接口权限列表出参对象
methodAuthList	方法名称列表	array	方法权限
methodName	方法名称	string
isAccess	是否有使用权限	boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "methodAuthList": [
 {
 "methodName": "method_bq7ylr0smpo1c",
 "isAccess": true
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

绑定数据模型列权限

接口地址:/weda/auth/v1/prod/bindColumnAuth

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "roleId": "1680507332078",
 "dataSourceId": "data-2WJ5tUFYY",
 "columnAuthList": [
 {
 "column": "fkxm",
 "auth": "rw"
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
绑定字段权限入参对象	绑定字段权限入参对象	body	true	绑定字段权限入参对象	绑定字段权限入参对象
roleId	角色Id		true	string
dataSourceId	数据源id		true	string
columnAuthList	字段权限列表		true	array	字段权限
column	字段标识		false	string
auth	字段权限，取值：无权限：n，仅查看：r，查看并修改：rw		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseBoolean

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为Boolean	公共出参对象，data类型为Boolean
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		boolean

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": true
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

查询角色绑定的数据模型列权限

接口地址:/weda/auth/v1/prod/describeColumnAuth

请求方式:GET

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
roleId	角色id	query	true	string
dataSourceId	数据源id	query	true	string
columnList	字段列表	query	true	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse字段权限出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为字段权限出参对象	公共出参对象，data类型为字段权限出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		字段权限出参对象	字段权限出参对象
columnAuthList	字段权限列表	array	字段权限
column	字段标识	string
auth	字段权限，取值：无权限：n，仅查看：r，查看并修改：rw	string

响应示例:

{
 "response": {
 "requestId": "",
 "error": {
 "code": "",
 "message": ""
 },
 "data": {
 "columnAuthList": [
 {
 "column": "fkxm",
 "auth": "rw"
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

资源鉴权

接口地址:/weda/auth/v1/{envType}/describeResourcesPermission

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "UserInfo": {
 "Uid": "151928937067085004a",
 "Source": 4
 },
 "ResourceList": [
 {
 "ResourceId": "app-x74toau6-u_biao_dan_ti_jiao",
 "SubResourceId": [],
 "MethodIdList": [],
 "ColumnList": []
 }
 ],
 "ResourceType": "app"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
资源鉴权入参对象	资源鉴权入参对象	body	true	资源鉴权入参对象	资源鉴权入参对象
UserInfo	用户信息		false	用户信息入参对象	用户信息入参对象
Uid	用户id		true	string
Source	来源,固定为4		true	integer
ResourceList	资源列表		false	array	资源权限入参对象
ResourceId	资源id,取值说明：自定义应用：应用id，模型应用：应用id，流程：流程id		true	string
SubResourceId	子资源id列表,取值说明：自定义应用：pageId，模型应用：pageId		false	array	string
MethodIdList	方法id列表		false	array	string
ColumnList	字段标识列表		false	array	string
ResourceType	资源类型,取值说明：自定义应用：app，模型应用：modelApp，数据源：dataSource，流程：flow		true	string

响应状态:

状态码	说明	schema
200	OK	ServerResponseList资源鉴权出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象，data类型为List资源鉴权出参对象	公共出参对象，data类型为List资源鉴权出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		array	资源鉴权出参对象
ResourceId	资源id	string
ResourceType	资源类型	string
IsAccess	是否有权限	boolean

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": [
 {
 "ResourceId": "app-x74toau6-u_biao_dan_ti_jiao",
 "ResourceType": "app",
 "IsAccess": true
 }
 ]
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

数据鉴权

接口地址:/weda/auth/v1/{envType}/describeAuthStrategy

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

{
 "UserInfo": {
 "Uid": "151928937067085004a",
 "Source": 4
 },
 "Resource": {
 "ResourceId": "app-x74toau6-u_biao_dan_ti_jiao",
 "ColumnList": []
 }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
数据鉴权入参对象		body	true	数据鉴权入参对象
UserInfo	用户信息		true	用户信息入参对象
Uid	用户id		true	string
Source	来源,固定为4		true	integer
Resource	资源对象		true	资源权限入参对象
ResourceId	资源id,取值说明：数据源id 数据源id获取方法：在weda控制台-数据模型模块-打开数据模型详情后，浏览器访问链接中detailDataSourceId的参数值即为数据源id		true	string
ColumnList	字段标识列表,用于获取传入字段列权限		false	array	string

响应状态:

状态码	说明	schema
200	OK	出参对象

响应参数:

参数名称	参数说明	类型	schema
Response		公共出参对象
RequestId	requestId	string
Error	错误信息	错误信息	错误信息
Code	错误码	string
Message	错误消息提示	string
Data		数据鉴权出参对象	数据鉴权出参对象
UserId	用户id	string
Permission	数据权限	数据权限对象	数据权限对象
ResourceId	资源id	string
RowPermission	行权限	数据行权限对象
Read	读权限	string
Type	权限类型参数说明： 1:无权限;2:查看本人;3:查看本部门及下属部门; 4:查看全部;5.本人及下属;6:自定义条件	integer
Scope	范围参数说明： type为1和4,此内容为空;type为2,scope为userid type为3,scope为下级组织架构id集合 type为5,scope为下级用户id集合	array	string
Write	写权限	string
Type	权限类型参数说明： 1:无权限;2:查看本人;3:查看本部门及下属部门; 4:查看全部;5.本人及下属;6:自定义条件	integer
Scope	范围参数说明： type为1和4,此内容为空;type为2,scope为userid type为3,scope为下级组织架构id集合 type为5,scope为下级用户id集合	array	string
ColumnPermission	字段权限(KEY取值为字段标识）	object

响应示例:

{
 "Response": {
 "RequestId": "",
 "Error": {
 "Code": "",
 "Message": ""
 },
 "Data": {
 "Permission": {
 "RowPermission": {
 "Read": {
 "Type": 1,
 "Scope": []
 },
 "Write": {
 "Type": 1,
 "Scope": []
 }
 },
 "ColumnPermission": {},
 "ResourceId": "data-2Nb189cVi"
 },
 "UserId": "1663382152219467778"
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

批量数据鉴权

接口地址:/weda/auth/v1/{envType}/describeBatchAuthStrategy

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
 "userId": "1692086238293827589",
 "resourceList": [
 {
 "resourceId": "data-2ZYkCBqB5",
 "columnIdList": []
 },
 {
 "resourceId": "data-2Z0a7Ems0",
 "columnIdList": []
 },
 {
 "resourceId": "data-2YrtgmaTx",
 "columnIdList": []
 }
 ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType	环境类型,prod正式环境,固定传prod	path	true	string
Authorization	鉴权参数,传入Bearer AccessToken;token获取方式详见概述	header	true	string
批量数据鉴权入参对象		body	true	批量数据鉴权入参对象
userId	weda用户id		true	string
weAppId	weda应用id 参数说明：如果传了此参数，用户未绑定角色时，会启用对应应用配置的权限设置进行鉴权		false	string
resourceList	资源列表		true	array
resourceId	资源id,取值说明：数据源id 数据源id获取方法：在weda控制台-数据模型模块-打开数据模型详情后，浏览器访问链接中detailDataSourceId的参数值即为数据源id		true	string
columnIdList	数据模型字段列表,用于获取传入字段列权限		false	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse批量数据鉴权出参对象

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		批量数据鉴权出参对象
authStrategyList		array	数据权限对象
resourceId	资源id	string
rowPermission	行权限	object
read	读权限	string
type	权限类型参数说明： 1:无权限;2:查看本人;3:查看本部门及下属部门; 4:查看全部;5.本人及下属;6:自定义条件	integer
scope	范围参数说明： type为1和4,此内容为空;type为2,scope为userid type为3,scope为下级组织架构id集合 type为5,scope为下级用户id集合	array	string
write	写权限	string
type	权限类型参数说明： 1:无权限;2:查看本人;3:查看本部门及下属部门; 4:查看全部;5.本人及下属;6:自定义条件	integer
scope	范围参数说明： type为1和4,此内容为空;type为2,scope为userid type为3,scope为下级组织架构id集合 type为5,scope为下级用户id集合	array	string
columnPermission	字段权限(KEY取值为字段标识）	object

响应示例:

{
 "response": {
 "requestId": "8918a0bbeff1f",
 "data": {
 "authStrategyList": [
 {
 "resourceId": "data-2ZYkCBqB5",
 "rowPermission": {
 "read": {
 "scope": [],
 "type": 4
 },
 "write": {
 "scope": [
 "1692086238293827587"
 ],
 "type": 2
 }
 },
 "columnPermission": {
 "flowkey": "rw"
 }
 },
 {
 "resourceId": "data-2Z0a7Ems0",
 "rowPermission": {
 "read": {
 "scope": [],
 "type": 4
 },
 "write": {
 "scope": [],
 "type": 1
 }
 },
 "columnPermission": {}
 },
 {
 "resourceId": "data-2YrtgmaTx",
 "rowPermission": {
 "read": {
 "scope": [],
 "type": 4
 },
 "write": {
 "scope": [],
 "type": 4
 }
 },
 "columnPermission": {}
 }
 ]
 }
 }
}

错误码: 以下仅列出了接口业务逻辑相关的错误码，其他公共错误码详见概述-接口异常返回。

错误码	描述
InvalidAction	接口不存在
InvalidParameter	参数错误
InvalidParameterValue	参数取值错误
MissingParameter	缺少参数错误
InternalError	内部错误
FailedOperation	操作失败,服务端异常

用户权限 API

管理用户​

创建用户​

删除用户​

更新用户​

用户详情​

用户列表​

批量新增用户​

触发同步任务​

查询同步任务状态​

授权、冻结用户license​

管理组织机构​

创建组织机构​

更新组织机构​

删除组织机构​

组织机构列表​

设置部门负责人​

管理角色​

创建角色​

更新角色​

删除角色​

查询角色详情​

角色列表​

根据角色查询用户列表​

用户关联角色​

取消角色关联的用户​

更新角色下授权的用户列表​

发布角色​

查询发布角色状态​

管理资源与权限​

绑定角色资源权限​

解绑角色资源权限​

校验角色资源权限​

绑定APIs接口权限​

查询角色绑定的APIs接口权限​

绑定数据模型列权限​

查询角色绑定的数据模型列权限​

资源鉴权​

数据鉴权​

批量数据鉴权​

管理用户

创建用户

删除用户

更新用户

用户详情

用户列表

批量新增用户

触发同步任务

查询同步任务状态

授权、冻结用户license

管理组织机构

创建组织机构

更新组织机构

删除组织机构

组织机构列表

设置部门负责人

管理角色

创建角色

更新角色

删除角色

查询角色详情

角色列表

根据角色查询用户列表

用户关联角色

取消角色关联的用户

更新角色下授权的用户列表

发布角色

查询发布角色状态

管理资源与权限

绑定角色资源权限

解绑角色资源权限

校验角色资源权限

绑定APIs接口权限

查询角色绑定的APIs接口权限

绑定数据模型列权限

查询角色绑定的数据模型列权限

资源鉴权

数据鉴权

批量数据鉴权