阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

搜索用户 API

  • 已更新:2021/01/28

    搜索用户 API

    使用搜索用户 API 在 Control Room 中搜索所有用户。

    先决条件

    确保您具有管理员角色或具有查看用户权限的自定义角色。

    过程

    1. 将认证令牌添加到请求标头。
    2. 应用筛选器执行基本条件查询和分页控制,以处理网页。有三个与筛选相关的基本功能:筛选条件、排序列和分页参数。请参阅 API 请求正文中的筛选器
    3. 使用 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"
            }
          ]
        }
      }
    4. 发送请求

      以下请求查找包含 adminusername,并在 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
          }
        ]
      }

      响应返回了包含字词 adminmdadminmt_admin 的两个用户名的数据。

      响应参数
      参数名称 描述
      id 创建用户的系统生成的 ID 号。
      username 新用户的用户名。
      Active Directory 域名。
      version 新用户由系统生成的版本号。
      电子邮件 新用户电子邮件地址。
      passwordSet 字符串: 8-15 字符;a-z、A-Z、0-9、@、-、_、!、#、$、%、& 和 .(句点)。仅设置新用户的密码。
      PrincipalId 创建新用户的活动目录主要用户的系统生成的 ID 号。
      权限 特定权限 ID。
      licenseFeature 与此角色关联的 Automation Anywhere 许可证。
      角色:id 与此用户关联的系统生成角色 ID 号。不是每个用户都有关联的角色。
      createdBy 创建新用户的管理员用户的系统生成 ID 号。
      updatedBy 更新用户的管理员用户的系统生成 ID 号。
      REST API 用 HTTP 响应代码响应每个请求。有关响应代码的详细信息,请参阅 API 响应代码
    发送反馈