閱讀及檢閱 Automation Anywhere 文件

Automation 360

關閉內容

內容

開啟內容

搜索用戶 API

  • 已更新:2022/09/21
    • Automation 360 v.x
    • 管理
    • RPA 工作區
    • API 文件

搜索用戶 API

使用 Search for users API 在 Control Room.

要求

POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list
Header: X-Authorization <<authentication token>>
所有 API 調用都必須在請求標頭中包含身份驗證令牌。使用 身份驗證 API 生成 JSON Web 令牌。 看 驗證 API.
要搜索用戶,您必須具備以下條件之一:
  • 管理員 角色
  • 查看用戶 權限的自定義角色
要求本文
{
  "filter": {
    "operator": "and",
    "operands": [
      "substring"
    ],
    "field": "name",
    "value": "device"
  },
  "sort": [
    {
      "field": "name",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "total": 100,
    "totalFilter": 100
  }
}

要求參數

參數 類型 必填 說明
sort 陣列 默認情況下,搜索結果按 ID 的降序排列。要指定備用排序,請使用 sort 查詢參數。

輸入要作為排序依據的欄位及其方向為 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。