增量匯入成員 API調試
簡介
API 簡介
本 API 以企業內的 username(使用者編號)為主鍵,更新建立企業成員。
API 調用
本 API 以企業內的 username(使用者編號)為主鍵,更新建立企業成員。
請求地址:https://api.jodoo.com/api/v5/corp/user/import
請求頻率:10 次/秒
請求方式:POST
注意事項:
- 使用者編號在企業內唯一,僅支援由字母、數字、下劃線組成;
- 使用者暱稱最長為 80 個字符;
- 所有使用者必須在部門下,如果匯入使用者不存在部門,則會移動到根部門下;
- 透過該 API 匯入的使用者會自動激活,且沒有信箱、密碼、手機號等資訊,可以配合單點登入功能實現企業使用者登入;
- 如果匯入資料存在,但是現有企業通訊錄中不存在該使用者,則新建成員;
- 如果匯入資料存在,且現有企業通訊錄中存在該使用者,則更新成員資訊;
- 該API不會執行刪除成員操作;
- 該API每次調用允許匯入的使用者數為 20000;
- 該API調用執行期間,將無法同時調用其他對通訊錄的修改、刪除、新增API。
請求參數:
參數 | 是否必需 | 類型 | 說明 |
users | 是 | Json[] | 使用者列表 |
users[].username | 是 | String | 使用者編號 |
users[].name | 是 | String | 暱稱 |
users[].departments | 是 | Number[] | 所在部門編號列表 |
請求範例:
{
"users": [{
"username": "coding_master",
"name": "小簡",
"departments": [1, 3]
}]
}
回應內容:
參數 | 類型 | 說明 |
status | String | 返回請求結果 |
回應範例:
{
"status": "success"
}