Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Authentifizierung (Benutzername und apiKey)

  • Aktualisiert: 2022/03/04
    • Automation 360 v.x
    • Verwalten
    • RPA Workspace
    • API-Dokumente

Authentifizierung (Benutzername und apiKey)

Verwenden Sie diese API, um den Zugriff auf eine Control Room mit dem Benutzernamen und apikey. Eine erfolgreiche Antwort erzeugt ein JSON-Web-Token. Ein generierter Token ist 20 Minuten lang gültig. Sie können das Token ohne das Kennwort des Benutzers generieren, z. B. für Unternehmen, die Single Sign-On (SSO) verwenden.

Um den Token zu generieren, benötigen Sie Folgendes:

  • Eine benutzerdefinierte Rolle mit der Berechtigung „API-Schlüssel generieren“
  • Gültig Nutzername und API-Schlüssel zum Control Room. Der API-Schlüssel ist eine 40-stellige Zeichenkette, die im Programm Control Room.

    API-Schlüsselgenerierungsrolle erstellen und zuweisen

Anforderung

POST http://{{ControlRoomURL}}/v1/authentication
Anforderungstext:
{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}
Anmerkung: Mit apiKey erzeugen Sie ein Multi-Session-Token. multipleLogin ist nicht anwendbar, wenn Sie den Parameter apiKey zur Anmeldung verwenden.
Anmerkung: apiKey oder Kennwort verwendet wird, um ein gültiges Token zu erzeugen. Beide (apiKey und Kennwort) können nicht zusammen in einem Anfragekörper verwendet werden.

Anforderungsparameter

Parameter Typ Beschreibung
Nutzername Zeichenfolge Geben Sie Ihren Nutzernamen ein.
apikey Zeichenfolge Geben Sie Ihren API-Schlüssel ein.
Anmerkung: Bei .24 oder früheren Versionen müssen Sie jedes Escape-Zeichen "\" durch "\" im API-Schlüssel ersetzen. Ab Version .25 enthält der API-Schlüssel keine Escape-Zeichen mehr ("\").

Antwort

{
   "token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
   "user":{
      "id":9,
      "email":"a@a.com",
      "username":"jdoe",
      "domain":null,
      "firstName":"j",
      "lastName":"doe",
      "version":9,
      "principalId":9,
      "deleted":false,
      "roles":[
         {
            "name":"API_Key_Generation",
            "id":23,
            "version":0
         },
         {
            "name":"AAE_Basic",
            "id":2,
            "version":0
         },
         {
            "name":"Docrole1",
            "id":18,
            "version":0
         }
      ],
      "sysAssignedRoles":[
         
      ],
      "groupNames":[
         
      ],
      "permissions":[
         ". . ."
      ],
      "licenseFeatures":[
         "RUNTIME"
      ],
      "emailVerified":true,
      "passwordSet":true,
      "questionsSet":true,
      "enableAutoLogin":false,
      "disabled":false,
      "clientRegistered":false,
      "description":"",
      "createdBy":1,
      "createdOn":"2022-03-10T13:39:56-05:00",
      "updatedBy":1,
      "updatedOn":"2022-03-13T02:09:38-05:00",
      "publicKey":null,
      "appType":null,
      "routingName":null,
      "appUrl":null
   }
}

Antwortparameter

Parameter Typ Beschreibung
token Zeichenfolge Generiertes Zugriffstoken, das als Sitzungs-ID fungiert und von der Anwendung für Anforderungen verwendet wird. Dieses Token ist gleichbedeutend mit den Nutzeranmeldedaten und muss geschützt werden.
Nutzer Objekt Nutzerobjekt, das mit allen Details des Nutzers zurückgegeben wird.
  • id: ID des Nutzers.
  • email: E-Mail-Adresse des Nutzers.
  • username: Nutzername des Nutzers.
  • domain: Domäne, bei der Sie angemeldet sind.
  • firstname: Vorname des Nutzers.
  • lastname: Nachname des Nutzers.
  • roles: Rollen, die dem Nutzer zugewiesen sind.
  • sysAssignedRoles: vom System zugewiesene Rollen.
  • permissions: Berechtigungen, die dem Nutzer zugewiesen sind.
  • licenseFeatures: Lizenz, die dem Nutzer zugewiesen ist.

Fügen Sie das Token in den Anforderungs-Header nachfolgender API-Anforderungen ein.

Feedback senden