搜索用戶 API
使用 搜索用戶 API 搜索中的所有用戶 Control Room。
先決條件
確保具有“ 查看用戶 ”權限的管理員角色或自定義角色。
程序
- 將驗證令牌添加到請求標頭。
- 套用篩選以執行基本條件查詢和分頁控制,以處理網頁。有三個與過濾相關的基本功能:過濾條件、排序列和分頁參數。請參閱API 請求主體中的過濾器。
-
使用 POST 方法和端點 URL :
<your _control_room _url>/v1/usermanagement/users/list
請求主體:
{ "fields": [], "filter": { "operator": "and", "operands": [ { "operator": "substring", "field": "username", "value": "mdadmin" }, { "operator": "gt", "field": "createdOn", "value": "2020-09-01T00:00:00.989Z" }, { "operator": "lt", "field": "createdOn", "value": "2020-09-06T23:00:00.123Z" } ] } }
-
發送請求。
下列要求會尋找
使用者名稱
包含admin
的所有使用者、並於 2020 年 9 月 1 日至 9 月 6 日期間建立。響應主體:{ "page": { "offset": 0, "total": 310, "totalFilter": 2 }, "list": [ { "id": 1513, "username": "mdadmin", "domain": "", "firstName": "MD_tester", "lastName": "MD_user", "version": 17, "principalId": 1513, "email": "md@aa.com", "emailVerified": true, "passwordSet": true, "questionsSet": true, "enableAutoLogin": false, "disabled": false, "clientRegistered": false, "description": "To be used for API testing", "createdBy": 1, "createdOn": "2020-09-01T11:01:17.760Z", "updatedBy": 1, "updatedOn": "2020-09-01T11:01:17.760Z", "licenseFeatures": [], "roles": [ { "id": 1, "name": "AAE_Admin" }, { "id": 2, "name": "AAE_Basic" } ], "deleted": false }, { "id": 1520, "username": "mt_admin", "domain": "", "firstName": "", "lastName": "", "version": 6, "principalId": 1520, "email": "a@a.com", "emailVerified": true, "passwordSet": true, "questionsSet": true, "enableAutoLogin": false, "disabled": false, "clientRegistered": false, "description": "", "createdBy": 1, "createdOn": "2020-09-02T08:47:19.723Z", "updatedBy": 1, "updatedOn": "2020-09-02T08:47:19.723Z", "licenseFeatures": [], "roles": [ { "id": 1, "name": "AAE_Admin" } ], "deleted": false } ] }
響應返回兩個用戶名的數據,該用戶名包含單詞
admin
、mdadmin
和mt_admin
。響應參數:參數名稱 描述 id 創建用戶的系統生成的 ID 號。 username 新用戶的用戶名。 網域 Active Directory 網域名稱。 version 系統爲新用戶生成的版本號。 電子郵件 新用戶電子郵件地址。 密碼設置 字串:8-15 個字元; a-z 、 A-Z 、 0-9 、 @ 、 、 _ 、 ! 、 # 、 $ 、 % 、 & 和。(期間)。僅爲新用戶設置密碼。 PrincipalId 創建新用戶的活動目錄主體用戶的系統生成 ID 號。 權限 特定權限 ID 。 許可特徵 Automation Anywhere 與此角色關聯的許可證。 角色: ID 與此用戶關聯的系統生成的角色 ID 號。並非每個用戶都具有關聯的角色。 createdBy 創建新用戶的管理員用戶的系統生成 ID 號。 更新者 系統生成的管理員用戶的 ID 號,該管理員用戶已更新該用戶。 REST API 會以 HTTP 回應碼回應每個要求。有關響應代碼的詳細信息,請參見 API 回應碼。