組織用戶(hù)管理
本文為您介紹組織用戶(hù)成員管理下的API接口(僅適用于獨(dú)立部署用戶(hù))。
查詢(xún)組織成員列表
接口路徑:
/openapi/v2/organization/user
(GET)接口描述:獲取組織下的用戶(hù)列表,分頁(yè)。
輸入?yún)?shù):
參數(shù)
數(shù)據(jù)類(lèi)型
描述
是否必需
keyword
String
賬戶(hù)或者昵稱(chēng)的模糊搜索關(guān)鍵字。
主要搜索字段:accountName或nickName。
否
pageNum
int
頁(yè)數(shù)。
默認(rèn)為1。
否
pageSize
int
頁(yè)碼。
默認(rèn)為10。
否
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
object
返回用戶(hù)列表的分頁(yè)結(jié)果,組織成員的詳細(xì)信息列表存放在返回參數(shù)Data中。
totalNum
int
總行數(shù)。
totalPages
int
總頁(yè)數(shù)。
pageSize
int
請(qǐng)求接口時(shí)設(shè)置的每頁(yè)行數(shù)。
pageNum
int
頁(yè)碼。
data
object []
成員列表。
accountId
string
賬號(hào)ID。
示例值:b5d8fd9348cc4327****afb604
userType
int
組織成員的用戶(hù)類(lèi)型。取值范圍:
1 :開(kāi)發(fā)者
2 :訪(fǎng)問(wèn)者
3 :分析師
示例值:1
accountName
string
賬號(hào)名。
示例值:xxxxxx@163.com
accountType
int
賬號(hào)類(lèi)型
nickName
string
賬號(hào)昵稱(chēng)。
示例值:張三
email
string
郵箱
phone
string
手機(jī)號(hào)
admin
boolean
是否是管理員。取值范圍:
true:是
false:否
示例值:true
重要參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
authAdmin
boolean
是否是權(quán)限管理員。取值范圍:
true:是
false:否
示例值:true
重要參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
userId
string
Quick BI中的UserID。
示例值:b5d8fd9348cc4327****afb604
roleIdList
List<long>
組織角色I(xiàn)D,最多3個(gè),包括但不限于組織預(yù)置角色:
組織管理員(預(yù)置角色):111111111
權(quán)限管理員(預(yù)置角色):111111112
普通用戶(hù)(預(yù)置角色):111111113
joinedDate
long
加入時(shí)間時(shí)戳
lastLoginTime
long
用戶(hù)最后登錄時(shí)間戳
返回參數(shù):
{ "traceId": "5d07a633-****-4c1e-8928-1c0aa177****", "code": null, "message": null, "data": { "next": null, "pre": null, "data": [{ "accountId": "4d9f22c4f15e****a1210313c3e4cb6e", "authAdmin": false, "accountName": "test_name", "phone": null, "roleIdList":[111111111,111111112,111111113], "nickName": "測(cè)試賬號(hào)", "accountType": 3, "admin": false, "userType": 1, "userId": "4d9f22c4f15e****a1210313c3e4cb6e", "email": null, "joinedDate": 1595575199000, "lastLoginTime": 1595575199000 }], "totalNum": 1, "totalPages": 1, "start": 0, "pageSize": 10, "orderBy": null, "pageNum": 1, "orderString": null }, "success": true }
JAVA SDK 示例:
@Test public static void QueryUserList() throws SDKException { HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user") .setMethod(HttpMethod.GET); // 非必填參數(shù) //request.addParameter("keyword",1); //request.addParameter("pageNum", 1); //request.addParameter("pageSize", 10); String result = openApiClient.syncExecute(request); System.out.println(result); }
添加組織成員
接口路徑:
/openapi/v2/organization/user
(POST)接口描述:向AK對(duì)應(yīng)的組織中,添加成員用戶(hù)。
輸入?yún)?shù):(content-type:application/json;charset=UTF-8,以JSON格式提交)。
參數(shù)
類(lèi)型
描述
是否必需
accountId
string
第三方系統(tǒng)的賬戶(hù) ID,此字段非必須。
若為空,則 quick bi 的 userId 自動(dòng)生成。
起始版本:獨(dú)立部署v3.6
注意:accountId必須保證唯一,如果是「Quick BI自建賬號(hào)」類(lèi)型,accountId 不生效,由系統(tǒng)自動(dòng)生成
否
accountName
string
賬戶(hù)名稱(chēng)。
格式檢查:最大長(zhǎng)度50個(gè)字符
注意:accountName 必須保證唯一
是
accountType
int
賬號(hào)類(lèi)型。accountType用于區(qū)分當(dāng)前是什么類(lèi)型的賬號(hào)。枚舉包含:
3:Quick BI自建賬號(hào)。
6:三方賬號(hào),即通過(guò)OAuth/SAML等協(xié)議對(duì)接到三方SSO系統(tǒng)的賬號(hào)。
起始版本:獨(dú)立部署3.12.1
注意:賬號(hào)類(lèi)型不為空
是
nickName
string
昵稱(chēng)。
格式檢查:最大長(zhǎng)度50個(gè)字符;特殊格式校驗(yàn)(中英文 數(shù)字 _ \ / | () [] )。注意:昵稱(chēng)必須保證唯一
是
admin
boolean
是否是組織管理員
注意 參數(shù)已過(guò)期不推薦使用,當(dāng)傳入RoleIds 時(shí)該參數(shù)無(wú)效。
是
email
string
email。
格式檢查:是否是郵件格式
否
userType
int
用戶(hù)類(lèi)型,1:開(kāi)發(fā)者類(lèi)型 2:訪(fǎng)問(wèn)者類(lèi)型 3:分析師類(lèi)型
默認(rèn)為1.
起始版本:獨(dú)立部署v3.6
注意:訪(fǎng)問(wèn)者類(lèi)型不會(huì)添加到默認(rèn)空間
否
phone
string
電話(huà)號(hào)碼。
格式檢查:是否是電話(huà)號(hào)碼,只能包含() + - 0-9的字符
否
roleIdList
List<string>
用戶(hù)綁定的預(yù)置或自定義組織角色I(xiàn)D,用英文逗號(hào)“,”分割,最多3個(gè)。取值范圍:
組織管理員(預(yù)置角色):111111111
權(quán)限管理員(預(yù)置角色):111111112
普通用戶(hù)(預(yù)置角色):111111113
否
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
object
返回新增用戶(hù)的詳細(xì)信息。
accountId
string
賬號(hào)ID。
示例值:b5d8fd9348cc4327****afb604
userType
int
組織成員的用戶(hù)類(lèi)型。取值范圍:
1 :開(kāi)發(fā)者
2 :訪(fǎng)問(wèn)者
3 :分析師
示例值:1
accountName
string
賬號(hào)名。
示例值:xxxxxx@163.com
accountType
int
賬號(hào)類(lèi)型
nickName
string
賬號(hào)昵稱(chēng)。
示例值:張三
email
string
郵箱
phone
string
手機(jī)號(hào)
admin
boolean
是否是管理員。取值范圍:
true:是
false:否
示例值:true
authAdmin
boolean
是否是權(quán)限管理員。取值范圍:
true:是
false:否
示例值:true
userId
string
Quick BI中的UserID。
示例值:b5d8fd9348cc4327****afb604
返回參數(shù):
{ "traceId":"308dc464-513b-****-bbe9-cd0d2fb9****", "code":null, "message":null, "data":{ "accountId": "test_123", "userType": 1, "accountName":"new_testss12***@alibaba.com", "accountType":3, "nickName":"測(cè)試小號(hào)123s12", "email":"xxxxxx123@163.com", "phone":"188****1111", "admin":true, "authAdmin":true, "userId":"44e6a073b****002840df64d50b16455" }, "success":true }
JAVA SDK 示例:
public void AddUser() throws Exception { HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user") .setMethod(HttpMethod.POST); request.addParameter("admin","false"); request.addParameter("authAdmin","false"); request.addParameter("userType","1"); request.addParameter("accountName","yubxx_202403152"); request.addParameter("nickName","yubxxi_202403152"); request.addParameter("accountType","3"); JSONArray roleIdList = new JSONArray(); roleIdList.add("111111111"); roleIdList.add("111111112"); request.addParameter("roleIdList",roleIdList); String result = openApiClient.syncExecute(request); System.out.println(result); }
刪除組織用戶(hù)
接口路徑:
/openapi/v2/organization/user/{userId}
(DELETE)輸入?yún)?shù): userId,路徑參數(shù)
接口描述:從組織中刪除用戶(hù),但是遇到空間owner,則無(wú)法刪除。該接口逐漸廢棄,請(qǐng)參見(jiàn)從組織中強(qiáng)制刪除用戶(hù)。
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
boolean
返回接口執(zhí)行結(jié)果。取值范圍:
true:執(zhí)行成功
false:執(zhí)行失敗
返回參數(shù):
{ "traceId":"2572dea3-2799-****-8e47-0cc1501bd59f", "code":null, "message":null, "data":true, # true,刪除成功 "success":true }
JAVA SDK 示例:
public static void DeleteUser() throws SDKException { String userId = "xxx"; HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/" + userId) .setMethod(HttpMethod.DELETE) .setHttpContentType(FormatType.JSON); String result = openApiClient.syncExecute(request); System.out.println(result); }
根據(jù)用戶(hù)ID查詢(xún)用戶(hù)信息
接口路徑:
/openapi/v2/organization/user/{userId}
(GET)輸入?yún)?shù): userId,路徑參數(shù)。
接口描述:獲取當(dāng)前組織下一個(gè)成員的具體信息。
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
object
返回用戶(hù)的詳細(xì)信息。
accountId
string
賬號(hào)ID。
示例值:b5d8fd9348cc4327****afb604
userType
int
組織成員的用戶(hù)類(lèi)型。取值范圍:
1 :開(kāi)發(fā)者
2 :訪(fǎng)問(wèn)者
3 :分析師
示例值:1
accountName
string
賬號(hào)名。
示例值:xxxxxx@163.com
accountType
int
賬號(hào)類(lèi)型
nickName
string
賬號(hào)昵稱(chēng)。
示例值:張三
email
string
郵箱
phone
string
手機(jī)號(hào)
admin
boolean
是否是管理員。取值范圍:
true:是
false:否
示例值:true
注意 參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
authAdmin
boolean
是否是權(quán)限管理員。取值范圍:
true:是
false:否
示例值:true
注意 參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
userId
string
Quick BI中的UserID。
示例值:b5d8fd9348cc4327****afb604
roleIdList
List<long>
組織角色I(xiàn)D,最多3個(gè),包括但不限于組織預(yù)置角色:
組織管理員(預(yù)置角色):111111111
權(quán)限管理員(預(yù)置角色):111111112
普通用戶(hù)(預(yù)置角色):111111113
返回參數(shù):
{ "traceId":"6796a38f-3084-****-a103-a20bb6498431", "code":null, "message":null, "data":{ "accountId": "test_123", "userType": 1, "accountName":"new_testss12***@alibaba.com", "accountType":"3", "nickName":"測(cè)試小號(hào)123s12", "email":"xxxxxx123@163.com", "phone":"188****0011", "admin":true, "authAdmin":true, "userId":"44e6a073b****002840df64d50b16455", "roleIdList":[111111111,656704594,795597636] }, "success":true }
重要該接口會(huì)做租戶(hù)隔離判斷,如果指定的userId不存在或者不屬于組織,會(huì)有拋錯(cuò)信息。拋錯(cuò)信息如下:
AE0150100004:該用戶(hù)不在組織中
AE0150100003:用戶(hù)不存在
{ "traceId":"e9418aae-2ba8-****-ae8b-ab681ef3dbf1", "code":"AE0150100004", // 錯(cuò)誤碼 "message":"該用戶(hù)不在組織中", // 錯(cuò)誤信息 "success":false }
JAVA SDK 示例:
public static void QueryUserInfoByUserId() throws SDKException { String userId = "xxx"; HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/" + userId) .setMethod(HttpMethod.GET); String result = openApiClient.syncExecute(request); System.out.println(result); }
更新組織成員信息
接口:
/openapi/v2/organization/user/{userId}
(PUT)接口描述:更新組織成員的昵稱(chēng)、email/phone/組織角色。
輸入?yún)?shù):(userId是路徑參數(shù)。其他為JSON串參數(shù),位于JSON串中,放到PUT請(qǐng)求的body中)
補(bǔ)充說(shuō)明(起始版本4.7.4):
當(dāng)admin和authAdmin都傳null時(shí),不修改用戶(hù)角色。
當(dāng)admin和authAdmin都未傳true,設(shè)置為普通用戶(hù)。
參數(shù)
類(lèi)型
描述
是否必需
userId
String
路徑參數(shù),用戶(hù)ID
是
admin
boolean
是否是組織管理員,傳入時(shí)會(huì)覆蓋用戶(hù)角色信息。
重要參數(shù)已過(guò)期不推薦使用,當(dāng)傳入RoleIds 時(shí)該參數(shù)無(wú)效。
否
authAdmin
boolean
是否是權(quán)限管理員,傳入時(shí)會(huì)覆蓋用戶(hù)角色信息(獨(dú)立部署4.7.4新增)。
重要參數(shù)已過(guò)期不推薦使用,當(dāng)傳入RoleIds 時(shí)該參數(shù)無(wú)效。
否
nickName
string
昵稱(chēng)。
格式檢查,最大長(zhǎng)度50個(gè)字符;特殊格式校驗(yàn)(中英文 數(shù)字 _ \ / | () [] )
否
userType
int
用戶(hù)類(lèi)型:
1:開(kāi)發(fā)者類(lèi)型
2:訪(fǎng)問(wèn)者類(lèi)型
3:分析師類(lèi)型
默認(rèn)為1。
起始版本:獨(dú)立部署v3.6
注意:訪(fǎng)問(wèn)者類(lèi)型不會(huì)添加到默認(rèn)空間
否
email
string
email。
格式檢查,郵件地址格式檢查
否
phone
string
電話(huà)號(hào)碼
格式檢查,電話(huà)號(hào)碼格式檢查,只能包含() + - 0-9這些字符
否
roleIdList
List<string>
用戶(hù)綁定的預(yù)置或自定義組織角色I(xiàn)D,用英文逗號(hào)“,”分割,最多3個(gè)。取值范圍:
組織管理員(預(yù)置角色):111111111
權(quán)限管理員(預(yù)置角色):111111112
普通用戶(hù)(預(yù)置角色):111111113
否
isDeleted
boolean
用戶(hù)狀態(tài)
激活-false
失效-true
否
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
boolean
返回接口執(zhí)行結(jié)果。取值范圍:
true:執(zhí)行成功
false:執(zhí)行失敗
返回參數(shù):
{ "traceId":"9bbd2088-6aeb-****-9ef3-082cc5a4f8f3", "code":null, "message":null, "data":true, "success":true }
JAVA SDK 示例:
public static void UpdateUser() throws SDKException { HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/{userId:.+}") .setMethod(HttpMethod.PUT); request.addParameter("admin","xxx"); request.addParameter("authAdmin","xxx"); request.addParameter("userType","xxx"); request.addParameter("nickName","xxx"); request.addParameter("email","xxx"); request.addParameter("phone","xxx"); JSONArray roleIdList = new JSONArray(); roleIdList.add("111111111"); //roleIdList.add("111111112"); request.addParameter("roleIdList",roleIdList); String result = openApiClient.syncExecute(request); System.out.println(result); }
判斷用戶(hù)是否屬于組織
接口路徑:
/openapi/v2/organization/user/{userId}/exist
(GET)接口描述:判斷指定的用戶(hù)是否屬于組織,存屬關(guān)系在返回結(jié)果中以true/fasle表示。
起始版本:獨(dú)立部署3.7
輸入?yún)?shù):
參數(shù)
類(lèi)型
描述
是否必需
userId
String
路徑參數(shù),用戶(hù)ID。
是
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
boolean
返回接口執(zhí)行結(jié)果。取值范圍:
true:用戶(hù)存在并屬于組織
false:用戶(hù)不屬于組織或不存在
返回參數(shù):
{ "traceId":"9bbd2088-6aeb-****-9ef3-082cc5a4f8f3", "code":null, "message":null, "data":true, // true:用戶(hù)存在并屬于組織 false: 用戶(hù)不屬于組織或不存在 "success":true }
JAVA SDK 示例:
public static void CheckOrganizationMember() throws SDKException { String userId = "xxx"; HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/" + userId + "/exist") .setMethod(HttpMethod.GET); String result = openApiClient.syncExecute(request); System.out.println(result); }
根據(jù)三方賬號(hào)查詢(xún)用戶(hù)信息
接口路徑:
/openapi/v2/organization/user/queryByAccount
(GET)接口描述:根據(jù)三方賬號(hào)(三方賬號(hào)ID、三方賬號(hào)名稱(chēng))獲取Quick BI中的用戶(hù)詳情。例如,使用三方賬號(hào)換取Quick BI的UserId。如果創(chuàng)建三方賬號(hào)的時(shí)候沒(méi)有傳入三方賬號(hào)ID,且賬號(hào)未登錄過(guò),則無(wú)法根據(jù)ID獲取到三方賬號(hào)信息。
起始版本: 獨(dú)立部署3.8.3
輸入?yún)?shù):
參數(shù)名
類(lèi)型
描述
是否必需
account
string
三方賬戶(hù)ID 或者賬戶(hù)名
是
accountType
integer
賬號(hào)類(lèi)型。
3:Quick BI自建賬號(hào)
6:三方賬號(hào)(通過(guò)OAuth等協(xié)議對(duì)接的客戶(hù)的系統(tǒng)賬號(hào))
注意:如果存在兩個(gè)相同賬戶(hù)名(account)的不同類(lèi)型的賬號(hào)時(shí),必須傳入該字段,否則拋錯(cuò)。
否
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
object
返回新增阿里云用戶(hù)的詳細(xì)信息。
accountId
string
賬號(hào)ID。
示例值:b5d8fd9348cc4327****afb604
userType
int
組織成員的用戶(hù)類(lèi)型。取值范圍:
1 :開(kāi)發(fā)者
2 :訪(fǎng)問(wèn)者
3 :分析師
示例值:1
accountName
string
賬號(hào)名。
示例值:xxxxxx@163.com
accountType
int
賬號(hào)類(lèi)型
nickName
string
賬號(hào)昵稱(chēng)。
示例值:張三
email
string
郵箱
phone
string
手機(jī)號(hào)
admin
boolean
是否是管理員。取值范圍:
true:是
false:否
示例值:true
注意 參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
authAdmin
boolean
是否是權(quán)限管理員。取值范圍:
true:是
false:否
示例值:true
注意 參數(shù)已過(guò)期不推薦使用,以RoleIds 參數(shù)為準(zhǔn)。
userId
string
Quick BI中的UserID。
示例值:b5d8fd9348cc4327****afb604
roleIdList
List<long>
組織角色I(xiàn)D,最多3個(gè),包括但不限于組織預(yù)置角色:
組織管理員(預(yù)置角色):111111111
權(quán)限管理員(預(yù)置角色):111111112
普通用戶(hù)(預(yù)置角色):111111113
返回參數(shù):
{ "traceId":"9bbd2088-****", "code":null, "message":null, "data":{ "accountName":"wang***@163.com", "accountId":"125446***", "accountType": 3, "nickName":"張三163", "admin":true, "authAdmin":false, "userId":"78212ee***", "userType":1, "phone":"139****8888", "email":"877***@xx.com", "roleIdList":[111111111,656704594,795597636] }, "success":true }
JAVA SDK 示例:
private static void QueryUserInfoByAccount() throws SDKException { HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/queryByAccount") .setMethod(HttpMethod.GET); request.addParameter("account", "125446280***"); // 非必填參數(shù) // request.addParameter("accountType", "3"); String result = client.syncExecute(request); System.out.println(result); }
強(qiáng)制刪除組織成員
接口路徑:
/openapi/v2/organization/user/forceDelete
(DELETE)接口描述:從當(dāng)前組織中強(qiáng)制刪除一個(gè)用戶(hù),并指定資源的接受者轉(zhuǎn)移者。如果資源接受者不屬于被刪除者的空間,則會(huì)把資源接受者加入對(duì)應(yīng)的空間之中。但是遇到以下情況,則刪除失敗:
被刪除者為組織owner
被刪除者是空間owner,但是資源轉(zhuǎn)移者為組織的分析師或者訪(fǎng)問(wèn)者(無(wú)法加入空間)。
被刪除者和資源轉(zhuǎn)移者都是空間成員,但是被刪除者的空間角色權(quán)限大于資源轉(zhuǎn)移者(空間管理員> 空間開(kāi)發(fā)者 > 空間分析師 > 空間閱覽者)
輸入?yún)?shù):(表單參數(shù)提交,content-type=application/x-wwww-url-encoded)
參數(shù)
類(lèi)型
描述
是否必需
userId
String
待刪除的用戶(hù)ID
是
transferUserId
String
資源接受者的用戶(hù)ID。不指定則默認(rèn)為空間Owner。
否
返回參數(shù)說(shuō)明(SDK調(diào)用時(shí),僅返回data部分):
參數(shù)
類(lèi)型
描述
traceId
string
請(qǐng)求ID。
code
string
拋錯(cuò)碼。取值范圍:
0:調(diào)用成功
AE或OE開(kāi)頭的異常碼:調(diào)用失敗
message
string
拋錯(cuò)信息。取值范圍:
success:調(diào)用成功
其他信息:調(diào)用失敗時(shí)的提示
success
boolean
是否請(qǐng)求成功。取值范圍:
true:請(qǐng)求成功
false:請(qǐng)求失敗
data
boolean
返回接口執(zhí)行結(jié)果。取值范圍:
true:刪除成功
false:刪除失敗
返回參數(shù):
{ "traceId":"9bbd2088-6aeb-****-9ef3-082cc5a4f8f3", "code":null, "message":null, "data":true, "success":true }
JAVA SDK 示例:
public static void ForceDeleteUser() throws SDKException { HttpRequest request = HttpRequest.build() .setUri("/openapi/v2/organization/user/forceDelete") .setMethod(HttpMethod.DELETE) .setHttpContentType(FormatType.FORM); request.addParameter("userId", "ad00a0ef3e7b42****"); // 非必填參數(shù) // request.addParameter("transferUserId", "0bff580a24f14e***"); String result = openApiClient.syncExecute(request); System.out.println(result); }