刪除現有用戶 API

使用刪除用戶 API 刪除現有用戶 Control Room.

要求

DELETE https://{{ControlRoomURL}}/v1/usermanagement/users/<user ID>

Header: X-Authorization <<authentication token>>

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。

要求參數


參數	類型	必填	說明
用戶身份	整數	是	輸入用戶的 ID。

回應

200 OK

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼，請參閱 API響應代碼.

先決條件

確保您具有管理員角色或具有 編輯用戶 權限的自定義角色。

網址： http://<your_control_room_url>/v1/usermanagement/users/2 <用戶 ID>
將尖括號中的內容替換為您的 Control Room 網址。
方法：刪除

程序

將身份驗證令牌或承載令牌添加到請求標頭。您不能在同一 API 中同時使用兩者。將身份驗證令牌添加到請求標頭。
在請求標頭中，添加要刪除的現有用戶 ID。
使用刪除方法。和端點 URL：<your_control_room_url>/v1/usermanagement/users/2 <user ID>

發送請求。

回應本文：

{
  "id": 3014,
  "email": "a@a.com",
  "username": "docstest01",
  "domain": null,
  "firstName": null,
  "lastName": null,
  "version": 4,
  "principalId": 3014,
  "deleted": false,
  "roles": [],
  "sysAssignedRoles": [],
  "groupNames": [],
  "permissions": [],
  "licenseFeatures": [],
  "emailVerified": true,
  "passwordSet": false,
  "questionsSet": false,
  "enableAutoLogin": false,
  "disabled": false,
  "clientRegistered": false,
  "description": null,
  "createdBy": 2623,
  "createdOn": "2020-01-31T17:33:16Z",
  "updatedBy": 3215,
  "updatedOn": "2020-03-22T22:51:48Z",
  "publicKey": null,
  "appType": null,
  "routingName": null,
  "appUrl": null
}

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼的詳細信息，請參見 API響應代碼.