Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Nach Benutzer-API suchen

  • Aktualisiert: 1/28/2021
    • Automation 360 v.x
    • Managen
    • RPA Workspace
    • API-Dokumente

Nach Benutzer-API suchen

Verwenden Sie die API „nach Benutzern suchen“, um nach allen Benutzern im Control Roomzu suchen.

Vorbereitungen

Stellen Sie sicher, dass Sie über eine Administratorrolle oder eine benutzerdefinierte Rolle mit der Berechtigung „Benutzer anzeigen“ verfügen.

Prozedur

  1. Fügen Sie das Authentifizierungstoken zum Anforderungsheader hinzu.
  2. Wenden Sie Filter an, um grundlegende bedingte Abfragen und die Seiteninierungssteuerung für die Verarbeitung von Webseiten durchzuführen. Es gibt drei grundlegende Funktionen im Zusammenhang mit dem Filtern: Filterbedingungen, Sortieren von Spalten und Paginierungsparameter. Einzelheiten finden Sie unter Filter in einem API-Anforderungskörper.
  3. Verwenden Sie die POST-Methode und die Endpunkt-URL:<Your_Control_Room_url>/v1/usermanagement/users/list

    Anforderungsorgan:

    {
      "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. Senden Sie die Anfrage.

    Mit der folgenden Anfrage werden alle Benutzer mit einem Benutzernamen gefunden, der admin enthält und zwischen dem 1. September und dem 6. September 2020 erstellt wurde.

    Antwortgremium:
    {
      "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
        }
      ]
    }

    Die Antwort gab Daten für zwei Benutzernamen zurück, die das Wort admin, mdadmin und mt_admin enthielten.

    Antwortparameter:
    Parametername Beschreibung
    id Vom System generierte ID-Nummer, die einen Benutzer erstellt hat.
    username Benutzername für einen neuen Benutzer.
    Domäne Active Directory-Domänenname.
    Version Systemgenerierte Versionsnummer für einen neuen Benutzer.
    E-Mail E-Mail-Adresse des neuen Benutzers.
    PasswortSet Zeichenfolge: 8-15 Zeichen; a-z, A-Z, 0-9, @, -, _, !, #, €, %, & und . (Punkt). Legen Sie ein Kennwort nur für einen neuen Benutzer fest.
    Prinzipal-ID Systemgenerierte ID-Nummer eines Active Directory-Hauptbenutzers, der einen neuen Benutzer erstellt hat.
    Berechtigung Eine bestimmte Berechtigungs-ID.
    Lizenzfeature Automation Anywhere Lizenz, die dieser Rolle zugeordnet ist.
    Rollen: id Systemgenerierte Rollen-ID-Nummer, die diesem Benutzer zugeordnet ist. Nicht jeder Benutzer hat eine zugewiesene Rolle.
    createdBy Systemgenerierte ID-Nummer eines Admin-Benutzers, der einen neuen Benutzer erstellt hat.
    Aktualisiert von Systemgenerierte ID-Nummer eines Admin-Benutzers, der den Benutzer aktualisiert hat.
    Die REST-API antwortet auf jede Anforderung mit einem HTTP-Antwortcode. Einzelheiten zu den Antwortcodes finden Sie unter API-Antwortcodes.
Feedback senden