Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Konfigurieren eines Berechtigungsnachweises mit Attributwerten über API

  • Aktualisiert: 2021/12/16
    • Automation 360 v.x
    • Erkunden
    • RPA Workspace

Konfigurieren eines Berechtigungsnachweises mit Attributwerten über API

Erstellen Sie einen Berechtigungsnachweis mit einem Standardattribut und fügen Sie zwei zusätzliche Attribute mit vom Benutzer eingegebenen Werten hinzu.

Vorbereitungen

Anmerkung: Sie können die Control Room APIs in der Community Editionaber die API-Funktionalität ist begrenzt. Sie benötigen eine lizenzierte Automation 360 Edition, um die volle Funktionalität der APIs nutzen zu können.
  • Alle API-Aufrufe müssen ein Authentifizierungs-Token in der Kopfzeile der Anfrage enthalten. Verwenden Sie die Authentifizierung API, um ein JSON-Web-Token zu erzeugen. Einzelheiten finden Sie unter Authentifizierungs-API.
  • Alle Rollen haben die Funktion Meine Anmeldeinformationen und Schließfächer verwalten das für die Konfiguration von Anmeldeinformationen und Attributen erforderlich ist. Für die Verwendung dieses Endpunkts sind keine zusätzlichen Berechtigungen erforderlich.
In diesem Beispiel konfigurieren Sie einen Berechtigungsnachweis mit drei Attributen für den E-Mail-Hostnamen, den Benutzernamen und das Passwort.

Prozedur

  1. Fügen Sie das Authentifizierungs-Token in die Kopfzeile der Anfrage ein.

Erstellen Sie einen Berechtigungsnachweis:

  1. Verwenden Sie die POST-Methode und die Endpunkt-URL:<Ihr_Kontrollraum_url>/v2/credentialvault/credentials.
    Körper der Anfrage: Diese Beispielanfrage enthält die folgenden erforderlichen Parameter:
    • userProvided: ein boolescher Wert, der festlegt, ob das Attribut die Eingabe eines Benutzers erfordert (true) oder standardmäßig für alle Benutzer ist (false).
    • maskiert: ein boolescher Wert, der festlegt, ob der Attributwert mit Sternchen maskiert wird (wahr) oder für die Benutzer sichtbar ist (false).
    {
      "name": "Email",
      "attributes": [
      	{
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 	
      ]
    }
  2. Senden Sie die Anfrage.
    Antwortkörper: Bei einer erfolgreichen Anfrage gibt dieser Endpunkt die folgenden Daten zurück:
    • id: ein eindeutiger numerischer Bezeichner für den Berechtigungsnachweis.
    • attribute:id: ein eindeutiger numerischer Bezeichner für das Attribut.
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:04:41.366464Z",
        "version": "0"
    }
    Die REST-API antwortet auf jede Anfrage mit einem HTTP-Antwortcode.Für Antwortcodes, siehe API-Antwort-Codes.

Weisen Sie dem Hostname-Attribut des Credentials einen Standardwert zu:

  1. Verwenden Sie die POST-Methode und die Endpunkt-URL:<Ihr_Kontrollraum_url>/v2/credentialvault/credentials/{credentialId}/attributevalues.
    {
      "list": [
        {
          "credentialAttributeId": "3335",
          "value": "mail.example.com"
        }
      ]
    }
  2. Senden Sie die Anfrage.
    Antwortkörper:
    {
      "list": [
        {
          "id": "1630",
          "credentialAttributeId": "3335",
          "value": "mail.example.com",
          "userId": "1508",
          "createdBy": "1508",
          "createdOn": "2020-12-28T22:04:41.366460Z",
          "updatedBy": "1508",
          "updatedOn": "2020-12-28T22:04:41.366464Z",
          "version": "0"
        }
      ]
    }
  3. Fügen Sie den Benutzernamen und Kennwort Attribute zu den E-Mail Berechtigungsnachweis. Verwenden Sie die PUT-Methode und die Endpunkt-URL:<Ihr_Kontrollraum_url>/v2/credentialvault/credentials/{credentialId}.
    Anmerkung: Sie müssen die vorhandenen Attribute zusammen mit den neuen Attributen in die Anfrage aufnehmen, da sonst die aktuellen Attribute überschrieben werden.
    Körper der Anfrage: Da Sie die ID der Anmeldeinformationen in der URL der Anfrage angegeben haben, ist es nicht erforderlich, die ID oder den Namen der Anmeldeinformationen in den Text der Anfrage aufzunehmen. In diesem Beispiel-Anfragetext wird der Nutzername und Kennwort Attribute mit Werten konfiguriert, die von jedem Benutzer eine andere Eingabe akzeptieren. Außerdem ist das Passwort-Attribut so konfiguriert, dass der eingegebene Wert mit Sternchen maskiert wird.
    {
        "attributes": [
      	{
          "name": "username",
          "userProvided": true,
          "masked": false
        },
         {
          "name": "password",
          "userProvided": true,
          "masked": true
        },
         {
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 		
      ]
    }
  4. Senden Sie die Anfrage.
    Antwortkörper: Der Antwortkörper gibt den Berechtigungsnachweis mit Angaben zu den drei Attributen zurück.
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3336",
                "name": "username",
                "description": "",
                "userProvided": true,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3337",
                "name": "password",
                "description": "",
                "userProvided": true,
                "masked": true,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:06:35.366464Z",
        "version": "2"
    }

Nächste Maßnahme

Wenn Sie die Schritte zur Konfiguration Ihres Credential Vaultbefolgen, gehen Sie wie folgt vor: Berechtigungsnachweis zuweisen locker API.
Feedback senden