跳到主要内容

用户权限 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": ""
},
"Orgs": [
{
"OrgId": "630dcf5384aecab01a06f44b5NRX68P50L",
"OrgIdentity": ""
}
],
"Description": "",
"UserExtend": ""
}

请求参数:

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

响应状态:

状态码说明schema
200OKServerResponse

响应参数:

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

响应示例:

{
"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正式环境,固定传prodpathtruestring
删除用户入参对象bodytrue删除用户入参对象
UserIdListweda用户id(传入一个weda用户id即可,只支持单个删除)truearraystring

响应状态:

状态码说明schema
200OKServerResponseBoolean

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
RequestIdrequestIdstring
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": ""
},
"Orgs": [
{
"OrgId": "630dcf5384aecab01a06f44b5NRX68P50L",
"OrgIdentity": ""
}
],
"Description": "",
"UserExtend": ""
}

请求参数:

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

响应状态:

状态码说明schema
200OKServerResponseBoolean

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
RequestIdrequestIdstring
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正式环境,固定传prodpathtruestring
查询用户入参对象查询用户入参对象bodytrue查询用户入参对象查询用户入参对象
UserIdweda用户idtruestring
RelatedType是否需要返回关联角色;
备注:不传当前参数默认不返回,需要返回角色传入:UserRelatedRole
falsestring
WithIdentities是否获取 IdP Token 信息falseboolean

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为用户出参对象
RequestIdrequestIdstring
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角色idstring
RoleDesc角色描述string
IsReleased是否发布boolean
UserDesc用户描述string
UserId用户idstring
Orgs兼岗部门array部门对象
OrgId部门idstring
OrgIdentity部门标识string
UserExtend用户数据源扩展信息,json串string
MainOrg主岗部门部门对象部门对象
OrgId部门idstring
OrgIdentity部门标识string
Identities外部身份源array
Provider身份源 IDstring
AccessToken在外部身份源中的 Access Tokenstring
RefreshToken在外部身份源中的 Refresh Tokenstring

响应示例:

{
"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",
"Orgs":[
{
"OrgId":"",
"OrgIdentity":""
}
],
"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正式环境,固定传prodpathtruestring
查询用户列表入参对象查询用户列表入参对象bodytrue查询用户列表入参对象查询用户列表入参对象
PageNo页码,默认为1falseinteger(int32)
PageSize每页数目,默认为100falseinteger(int32)

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象
RequestIdrequestIdstring
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角色idstring
RoleDesc角色描述string
IsReleased是否发布boolean
UserDesc用户描述string
UserId用户idstring
Orgs兼岗部门array部门对象
OrgId部门idstring
OrgIdentity部门标识string
UserExtend用户数据源扩展信息,json串string
MainOrg主岗部门部门对象部门对象
OrgId部门idstring
OrgIdentity部门标识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",
"Orgs": [
{
"OrgId": "",
"OrgIdentity": ""
}
],
"UserExtend": "",
"MainOrg": {
"OrgId": "",
"OrgIdentity": ""
}
}
]
}
}
}

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

错误码描述
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"
},
"orgs": [
{
"orgId": "4ebb756064db216a01025c7057c98bca"
}
]
}
]
}

请求参数:

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

响应状态:

状态码说明schema
200OKOpenApiServerResponse

响应参数:

参数名称参数说明类型schema
response公共出参对象公共出参对象
requestIdrequestIdstring
error错误信息错误信息错误信息
code错误码string
message错误消息提示string
data出参对象
users用户列表array用户对象
userIdweda用户idstring
uuid客户系统用户id;不传则由系统生成false
name用户名true
nickName用户昵称false
phone手机号false
email邮箱false
parentUserId直属上级用户idfalse
roleIds角色id列表false
mainOrg主岗部门false
orgId部门idtrue
orgIdentity部门标识false
orgs兼岗部门false
orgId部门idtrue
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"
},
"orgs": [
{
"orgId": "4ebb756064db216a01025c7057c98bca"
}
],
"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"
},
"orgs": [
{
"orgId": "4ebb756064db216a01025c7057c98bca"
}
],
"appId": 1307578329,
"internalUserType": 0
}
]
}
}
}

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

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

触发同步任务

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

请求示例:

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

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
envType环境类型,prod正式环境,固定传prodpathtruestring
触发同步任务入参对象触发同步任务入参对象bodytrue触发同步任务入参对象触发同步任务入参对象
EnvId环境idfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"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正式环境,固定传prodpathtruestring
查询同步任务状态入参对象查询同步任务状态入参对象bodytrue查询同步任务状态入参对象查询同步任务状态入参对象
EnvId环境idfalsestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为查询同步任务状态出参对象公共出参对象,data类型为查询同步任务状态出参对象
RequestIdrequestIdstring
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正式环境,固定传prodpathtruestring
授权license入参对象授权、冻结用户列表不能均为空bodytrue授权license入参对象授权license入参对象
GrantUserIdList授予license的userId列表falsearraystring
FreezeUserIdList冻结license的userId列表falsearraystring

响应状态:

状态码说明schema
200OKServerResponseBoolean

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
Databoolean

响应示例:

{
"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正式环境,固定传prodpathtruestring
新增部门入参对象bodytrue新增部门入参对象新增部门入参对象
OrgData部门信息;格式:部门信息json字符串;包含以下参数:
departmentCode部门标识,必填,不能重复,格式为1-64位的字符串并且只能包含英文字母、数字、下划线、'.'和'-';
departmentName部门名称,必填,格式为2-32位的字符串,只能包含英文字母、数字、下划线、'.'和'-'且只能以字母或中文开头;
departmentParentCode上级部门标识,非必填,备注:上级部门的部门标识。
部门数据模型扩展字段,可以存在多个,非必填。例如示例中的info字段,可以在新增部门同时为扩展字段赋值。
示例:{\"departmentCode\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"\",\"info\":\"扩展字段值\"}
truestring

响应状态:

状态码说明schema
200OKServerResponseString

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为String公共出参对象,data类型为String
RequestIdrequestIdstring
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\":\"扩展字段值\"}"
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
envType环境类型,prod正式环境,固定传prodpathtruestring
更新部门入参对象更新部门入参对象bodytrue
OrgData部门信息;格式:部门信息json字符串;包含以下参数:
_id部门id,必填;departmentName部门名称,非必填,不传则不更新;departmentParentCode上级部门标识,非必填,不传不更新。
部门数据模型扩展字段,非必填,不传则不更新。例如示例中的info字段,可以在根据部门id更新扩展信息。
示例:{\"_id\":\"zbm_kfbm\",\"departmentName\":\"开放部门\",\"departmentParentCode\":\"zbm_kfbm_parent\",\"info\":\"扩展字段值\"}
truestring

响应状态:

状态码说明schema
200OKServerResponseLong

响应参数:

参数名称参数说明类型schema
Response公共出参对象公共出参对象
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
DataupdateNuminteger(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正式环境,固定传prodpathtruestring
删除部门入参对象删除部门入参对象bodytrue删除部门入参对象删除部门入参对象
OrgId部门id,创建组织架构接口返回truestring

响应状态:

状态码说明schema
200OKServerResponseLong

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为Long公共出参对象,data类型为Long
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
DatadeletedNuminteger(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
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
envType环境类型,prod正式环境,固定传prodpathtruestring
查询部门列表入参对象查询部门列表入参对象bodytrue查询部门列表入参对象查询部门列表入参对象
PageNo页码,默认为1falseinteger(int32)
PageSize每页数目,默认为1000falseinteger(int32)

响应状态:

状态码说明schema
200OKServerResponse

响应参数:

参数名称参数说明类型schema
Response公共出参对象公共出参对象
RequestIdrequestIdstring
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
设置部门负责人入参对象bodytrue设置部门负责人对象
orgId部门idtruestring
userIdList部门负责人weda用户id列表。
全量更新,每次接口调用都使用传入的用户作为部门负责人,未传入会从部门负责人中删除。
传空或者不传此参数,表示部门没有部门负责人
falsearraystring

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

参数名称参数说明类型schema
response
requestIdrequestIdstring
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
创建角色入参对象创建角色入参对象bodytrue创建角色入参对象创建角色入参对象
roleName角色名称truestring
roleIdentity角色标识truestring
description描述falsestring

响应状态:

状态码说明schema
200OKOpenApiServerResponseString

响应参数:

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

响应示例:

{
"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
更新角色入参对象更新角色入参对象bodytrue更新角色入参对象更新角色入参对象
roleId角色id,由创建用户接口返回truestring
roleName角色名称,不传则不更新falsestring
description描述,不传则不更新falsestring

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

参数名称参数说明类型schema
response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
requestIdrequestIdstring
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
roleId角色idquerytruestring

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

参数名称参数说明类型schema
response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
requestIdrequestIdstring
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
roleName角色名称querytruestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
response公共出参对象公共出参对象
requestIdrequestIdstring
error错误信息错误信息错误信息
code错误码string
message错误消息提示string
data关联角色角色详情对象角色详情对象
roleName角色名称string
roleIdentity角色标识string
roleId角色idstring
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正式环境,固定传prodpathtruestring
角色列表入参对象角色列表入参对象bodytrue角色列表入参对象角色列表入参对象
PageNo页码falseinteger(int32)
PageSize每页数目falseinteger(int32)

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为角色列表出参对象公共出参对象,data类型为角色列表出参对象
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
Data角色列表出参对象角色列表出参对象
Total总数integer
RoleList关联角色array角色详情对象
Name角色名称string
RoleIdentity角色标识string
Id角色idstring
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正式环境,固定传prodpathtruestring
查询角色用户入参对象查询角色用户入参对象bodytrue查询角色用户入参对象查询角色用户入参对象
RoleId角色idtruestring
PageNo页码falseinteger(int32)
PageSize每页数目falseinteger(int32)

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为查询用户出参对象公共出参对象,data类型为查询用户出参对象
RequestIdrequestIdstring
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角色idstring
RoleDesc角色描述string
IsReleased是否发布boolean
UserDesc用户描述string
UserId用户idstring
Orgs主岗部门array部门对象
OrgId部门idstring
OrgIdentity部门标识string
UserExtend用户数据源扩展信息,json串string
MainOrg主岗部门部门对象部门对象
OrgId部门idstring
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正式环境,固定传prodpathtruestring
关联用户入参对象关联用户入参对象bodytrue关联用户入参对象关联用户入参对象
AuthorizeParam绑定参数falsearray角色关联用户对象
UserIdweda用户idtruestring
RoleIds角色id列表,覆盖式更新,不传或者空数组表示不绑定任何角色falsearraystring

响应状态:

状态码说明schema
200OKServerResponseBoolean

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
RequestIdrequestIdstring
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
取消角色关联用户入参对象取消角色关联用户入参对象bodytrue取消角色关联用户入参对象取消角色关联用户入参对象
roleId角色Idtruestring
userIds取消关联的用户Id列表truearraystring

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

参数名称参数说明类型schema
response公共出参对象,data类型为Boolean公共出参对象,data类型为Boolean
requestIdrequestIdstring
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
更新角色下授权的用户bodytrue
roleId角色idtruestring
userIds授权的weda用户id列表truearraystring

响应状态:

状态码说明schema
200OKBoolean

响应参数:

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

响应示例:

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

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

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

发布角色

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

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

请求参数:

空对象

响应状态:

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

响应参数:

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

响应示例:

{
"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
taskId角色发布任务idquerytruestring

响应状态:

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

响应参数:

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

响应示例:

{
"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
绑定和解绑角色权限入参对象绑定和解绑角色权限入参对象bodytrue绑定和解绑角色权限入参对象绑定和解绑角色权限入参对象
roleId角色Idtruestring
resourceType资源类型,参数取值:自定义应用:app,自定义应用页面:page,模型应用:modelApp,模型应用页面:modelAppPage,数据源行权限:dataSource,流程:flow,truestring
resourceIds资源唯一标志符,参数取值:自定义应用:应用id,自定义应用页面:应用id-页面id,模型应用:应用id,模型应用页面:应用id-页面id,数据源行权限:数据模型id,流程:流程标识,truearraystring
rowPermissionParams行权限falsearray数据行权限对象
rowPermissionScopeType范围类型,取值:全部数据:all,部门及下级部门数据:org,本人及下属数据:staff,本人数据:mefalsestring
rowPermissionOperationType取值:只读:r,读写:rwfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"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
绑定和解绑角色权限入参对象bodytrue绑定和解绑角色权限入参对象
roleId角色Idtruestring
resourceType资源类型,参数取值:自定义应用:app,自定义应用页面:page,模型应用:modelApp,模型应用页面:modelAppPage,数据源行权限:dataSource,流程:flow,truestring
resourceIds资源唯一标志符,参数取值:自定义应用:应用id,自定义应用页面:应用id-页面id,模型应用:应用id,模型应用页面:应用id-页面id,数据源行权限:数据模型id,流程:流程标识,truearraystring
rowPermissionParams行权限falsearray数据行权限对象
rowPermissionScopeType范围类型,取值:全部数据:all,部门及下级部门数据:org,本人及下属数据:staff,本人数据:mefalsestring
rowPermissionOperationType取值:只读:r,读写:rwfalsestring

响应状态:

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

响应参数:

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

响应示例:

{
"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
校验权限对象bodytrue校验权限对象
roleId角色Idtruestring
resourceType资源类型,参数取值:自定义应用:app,自定义应用页面:page,模型应用:modelApp,模型应用页面:modelAppPage,数据源行权限:dataSource,流程:flow,truestring
resourceIds资源唯一标志符,参数取值:自定义应用:应用id,自定义应用页面:应用id-页面id,模型应用:应用id,模型应用页面:应用id-页面id,数据源行权限:数据模型id,流程:流程标识,truearraystring

响应状态:

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

响应参数:

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

响应示例:

{
"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
接口权限入参对象接口权限入参对象bodytrue接口权限入参对象接口权限入参对象
roleId角色Idtruestring
dataSourceIdAPIs对应的数据源idtruestring
methodList方法名称列表truearray方法权限
methodName方法名称falsestring
isAccess是否有使用权限falseboolean

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

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

响应示例:

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

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

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

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

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

请求方式:GET

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
roleId角色idquerytruestring
dataSourceIdAPIs对应的数据源idquerytruestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
response公共出参对象,data类型为接口权限列表出参对象公共出参对象,data类型为接口权限列表出参对象
requestIdrequestIdstring
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
绑定字段权限入参对象绑定字段权限入参对象bodytrue绑定字段权限入参对象绑定字段权限入参对象
roleId角色Idtruestring
dataSourceId数据源idtruestring
columnAuthList字段权限列表truearray字段权限
column字段标识falsestring
auth字段权限,取值:无权限:n,仅查看:r,查看并修改:rwfalsestring

响应状态:

状态码说明schema
200OKOpenApiServerResponseBoolean

响应参数:

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

响应示例:

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

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

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

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

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

请求方式:GET

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
roleId角色idquerytruestring
dataSourceId数据源idquerytruestring
columnList字段列表querytruearraystring

响应状态:

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

响应参数:

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

响应示例:

{
"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正式环境,固定传prodpathtruestring
资源鉴权入参对象资源鉴权入参对象bodytrue资源鉴权入参对象资源鉴权入参对象
UserInfo用户信息false用户信息入参对象用户信息入参对象
Uid用户idtruestring
Source来源,固定为4trueinteger
ResourceList资源列表falsearray资源权限入参对象
ResourceId资源id,取值说明:自定义应用:应用id, 模型应用:应用id, 流程:流程idtruestring
SubResourceId子资源id列表,取值说明:自定义应用:pageId,模型应用:pageIdfalsearraystring
MethodIdList方法id列表falsearraystring
ColumnList字段标识列表falsearraystring
ResourceType资源类型,取值说明: 自定义应用:app, 模型应用:modelApp, 数据源:dataSource, 流程:flowtruestring

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象,data类型为List资源鉴权出参对象公共出参对象,data类型为List资源鉴权出参对象
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
Dataarray资源鉴权出参对象
ResourceId资源idstring
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正式环境,固定传prodpathtruestring
数据鉴权入参对象bodytrue数据鉴权入参对象
UserInfo用户信息true用户信息入参对象
Uid用户idtruestring
Source来源,固定为4trueinteger
Resource资源对象true资源权限入参对象
ResourceId资源id,取值说明:数据源id
数据源id获取方法:
在weda控制台-数据模型模块-打开数据模型详情后,
浏览器访问链接中detailDataSourceId的参数值即为数据源id
truestring
ColumnList字段标识列表,用于获取传入字段列权限falsearraystring

响应状态:

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

响应参数:

参数名称参数说明类型schema
Response公共出参对象
RequestIdrequestIdstring
Error错误信息错误信息错误信息
Code错误码string
Message错误消息提示string
Data数据鉴权出参对象数据鉴权出参对象
UserId用户idstring
Permission数据权限数据权限对象数据权限对象
ResourceId资源idstring
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集合
arraystring
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集合
arraystring
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正式环境,固定传prodpathtruestring
批量数据鉴权入参对象bodytrue批量数据鉴权入参对象
userIdweda用户idtruestring
weAppIdweda应用id
参数说明:如果传了此参数,用户未绑定角色时,会启用对应应用配置的权限设置进行鉴权
falsestring
resourceList资源列表truearray
resourceId资源id,取值说明:数据源id
数据源id获取方法:
在weda控制台-数据模型模块-打开数据模型详情后,
浏览器访问链接中detailDataSourceId的参数值即为数据源id
truestring
columnIdList数据模型字段列表,用于获取传入字段列权限falsearraystring

响应状态:

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

响应参数:

参数名称参数说明类型schema
response公共出参对象
requestIdrequestIdstring
error错误信息错误信息错误信息
code错误码string
message错误消息提示string
data批量数据鉴权出参对象
authStrategyListarray数据权限对象
resourceId资源idstring
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集合
arraystring
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集合
arraystring
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操作失败,服务端异常