搜索用戶 API

使用搜索用戶 API 搜索 Control Room.

要求

POST http://{{ControlRoomURL}}/v1/usermanagement/users/list

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

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

要搜索用戶，您必須具備以下條件之一：

管理員角色
查看用戶權限的自定義角色

要求本文：

{
  "filter": {
    "operator": "and",
    "operands": [
      "substring"
    ],
    "field": "name",
    "value": "device"
  },
  "sort": [
    {
      "field": "name",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "total": 100,
    "totalFilter": 100
  }
}

要求參數


參數	類型	必填	說明
sort	陣列	否	默認情況下，搜索結果按 ID 降序排列。要指定替代排序，請使用排序查詢參數。輸入要作為排序依據的欄位及其方向為 `asc` (遞增) 或 `desc` (遞減)。
篩選	物件	否	篩選結果。
頁	物件	否	page 對象允許您獲得所需的頁面數。

如需有關篩選、分頁和排序的詳細資訊，請參閱篩選、分頁和排序。

回應

{
    {
  "page": {
    "offset": 0,
    "total": 100,
    "totalFilter": 100
  },
  "list": [
    {
      "id": 110,
      "roles": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "permissions": [
        {
          "id": 59,
          "action": "managecredentials",
          "resourceId": null,
          "resourceType": "credentials"
        }
      ],
      "licenseFeatures": [
        "DEVELOPMENT"
      ],
      "principalId": 110,
      "domain": null,
      "email": "xyz@automationanywhere.com",
      "emailVerified": true,
      "passwordSet": true,
      "questionsSet": true,
      "enableAutoLogin": true,
      "username": "bot_creator",
      "firstName": "Mike",
      "lastName": "Bots",
      "description": "User to manage bots",
      "disabled": true,
      "clientRegistered": true,
      "createdBy": 27,
      "createdOn": "2022-03-17T19:32:20.620Z",
      "updatedBy": 29,
      "updatedOn": "2022-03-24T02:20:13.787Z"
    }
  ]
}

回應參數


參數	類型	說明
偏移	整數	用於分頁的開始清單偏移值。
總計	整數	記錄總次數。
totalFilter	整數	套用篩選後的記錄次數。
清單	陣列	列表角色對象的數組。
列出角色對象
ID	整數	特定角色的唯一 ID。
名稱	字串	角色名稱。
權限	陣列	已分配給角色的唯一權限的集合。
許可證功能	字串	許可證功能包括 - 開發 - 運行時 - IQBOTRUNTIME - ANALYTICSCLIENT - ANALYTICSAPI
說明	字串	角色描述。
主體ID	數字	主要用戶的唯一 ID。
電子郵件	整數	用戶的電子郵件 ID。
電子郵件已驗證	布林值	指示電子郵件 ID 是否已驗證。
密碼設置	布林值	指示用戶是否設置了密碼。
啟用自動登錄	布林值	指示是否為用戶啟用自動登錄。
使用者名稱	字串	用戶登錄名。
名	字串	為用戶指定的名字。
姓	字串	為用戶指定的姓氏。
createdBy	整數	創建角色的用戶的 ID。
createdOn	字串	創建角色時的時間戳。
更新者	整數	上次更新角色的用戶的 ID。
更新日期	字串	上次更新角色時的時間戳。
系統角色	布林值	指示此角色是否為系統角色。

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

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