Ознакомиться с документацией Automation Anywhere

Automation Anywhere Automation 360

Закрыть содержимое

Содержимое

Открыть содержимое

Поиск API пользователей

  • Обновлено: 1/28/2021
    • Automation 360 v.x
    • Управление
    • Рабочая область RPA
    • Документы API

Поиск 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. Отправьте запрос.

    В следующем запросе будут найдены все пользователи с именем пользователя admin , которые были созданы в период с 1 сентября по 6 сентября 2020 г.

    Ответный текст:
    {
      "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 Сгенерированный системой идентификационный номер, создавший пользователя.
    имя пользователя Имя пользователя для нового пользователя.
    домен Имя домена Active Directory.
    версия Сгенерированный системой номер версии для нового пользователя.
    электронная почта Новый адрес электронной почты пользователя.
    Набор паролей Строка: 8-15 символов; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, и . (период). Установите пароль только для нового пользователя.
    ID_принципalId Сгенерированный системой идентификационный номер активного пользователя-участника каталога, создавшего нового пользователя.
    Разрешение Определенный идентификатор разрешения.
    LicenseFeature Automation Anywhere лицензия, связанная с этой ролью.
    Роли: id Сгенерированный системой идентификационный номер роли, связанный с этим пользователем. Не каждый пользователь имеет связанную роль.
    Крейд Сгенерированный системой идентификационный номер пользователя-администратора, создавшего нового пользователя.
    UpdatedBy Сгенерированный системой идентификационный номер пользователя-администратора, который обновил пользователя.
    API-интерфейс REST отвечает на каждый запрос с помощью кода ответа HTTP. Подробные сведения о кодах ответа см. Коды отклика APIв разделе .
Отправить отзыв