Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Suche nach Benutzern API

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

Suche nach Benutzern API

Verwenden Sie die Suche nach Benutzern API für die Suche nach allen Benutzern in der Control Room.

Vorbereitungen

Stellen Sie sicher, dass Sie eine Administratorrolle oder eine benutzerdefinierte Rolle mit Benutzer anzeigen Berechtigung.

Prozedur

  1. Fügen Sie das Authentifizierungs-Token in die Kopfzeile der Anfrage ein.
  2. Anwendung von Filtern zur Durchführung grundlegender bedingter Abfragen und zur Steuerung der Paginierung bei der Bearbeitung von Webseiten. Es gibt drei grundlegende Funktionen im Zusammenhang mit der Filterung: Filterbedingungen, Sortierspalten und Paginierungsparameter. Einzelheiten finden Sie unter Filtern, Paginieren und Sortieren.
  3. Verwenden Sie die POST-Methode und die Endpunkt-URL:<your_control_room_url>/v1/usermanagement/users/list

    Anforderungstext:

    {
      "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.

    Die folgende Anfrage findet alle Benutzer mit einem Benutzernamen mit dem Inhalt admin enthält und zwischen dem 1. und 6. September 2020 erstellt wurde.

    Antworttext:
    {
      "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 lieferte Daten für zwei Benutzernamen, die das Wort admin, mdadmin und mt_admin.

    Antwort-Parameter:
    Parameter Name Beschreibung
    id Vom System generierte ID-Nummer, die einen Benutzer erstellt hat.
    Nutzername Nutzername für einen neuen Nutzer.
    Domain Active-Directory-Domänenname.
    Version Vom System generierte Versionsnummer für einen neuen Benutzer.
    E-Mail Neue Benutzer-E-Mail-Adresse.
    passwordSet Zeichenfolge: 8-15 Zeichen; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, und . (Punkt). Legen Sie ein Passwort nur für einen neuen Benutzer fest.
    PrincipalId Vom System generierte ID-Nummer eines Active-Directory-Hauptbenutzers, der einen neuen Benutzer angelegt hat.
    Berechtigung Eine bestimmte Berechtigungs-ID.
    licenseFeature Automation Anywhere Lizenz, die mit dieser Rolle verbunden ist.
    Rollen: id Vom System generierte Rollen-ID-Nummer, die mit diesem Benutzer verbunden ist. Nicht jeder Benutzer hat eine zugehörige Rolle.
    createdBy Vom System generierte ID-Nummer eines Admin-Benutzers, der einen neuen Benutzer angelegt hat.
    updatedBy Vom System generierte ID-Nummer eines Admin-Benutzers, der den Benutzer aktualisiert hat.
    Die REST-API antwortet auf jede Anfrage mit einem HTTP-Antwortcode. Für Details zu den Antwortcodes, siehe API-Antwort-Codes.
Feedback senden