查詢用戶列表v3
更新時間 2025-08-07 16:49:52
最近更新時間: 2025-08-07 16:49:52
分享文章
接口功能介紹
查詢用戶列表v3
接口約束
無
URI
GET /v3/user/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| orgOid | 否 | String | 部門Oid，默認為根部門 | ||
| querySubOrg | 否 | Boolean | 是否包含下級部門。默認為false。 | ||
| userName | 否 | String | 用戶名稱 | ||
| 否 | String | 通知郵箱 | |||
| userAccount | 否 | String | 用戶賬號 | ||
| pubUserOids | 否 | String | 用戶ID。取值由用戶ID組成一個JSON數組，最多支持10個ID，ID之間用半角逗號（,）隔開。 | ||
| pageNum | 否 | Integer | 頁碼，至少1，默認1 | ||
| pageSize | 否 | Integer | 每頁數量，最大100，默認10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | ||
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| pubUserOid | String | 用戶ID | ||
| orgOid | String | 部門ID | ||
| String | 通知郵箱 | |||
| gender | String | 性別 | ||
| telephone | String | 固定電話 | ||
| position | String | 職位 | ||
| userName | String | 用戶名 | ||
| desktopNums | Integer | 云電腦數量 | ||
| status | Byte | 狀態（1-有效，3-待確認） | ||
| loginAccount | String | 登錄賬戶 | ||
| userAccount | String | 用戶賬戶 | ||
| lockStatus | Byte | 鎖定狀態(0-未鎖定;1-鎖定) | ||
| desktopAdminPriv | String | 賬號權限(DesktopUser-普通權限;DesktopAdmin-本地管理員權限) |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"pubUserOid":"upg-xxx",
"orgOid":"org-foo",
"email":"foo@foo.com",
"gender":"男",
"telephone":"xxxxxxxx",
"position":"xxxxxxxxx",
"userName":"foo",
"desktopNums":0,
"status":1,
"loginAccount":"foo#id",
"userAccount":"foo",
"lockStatus":0,
"desktopAdminPriv":"DesktopUser"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
