Leggi e rivedi la documentazione di Automation Anywhere

Automation Anywhere Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

Configurazione di una credenziale con valori di attributo utilizzando l'API

  • Aggiornato: 2021/01/31

    Configurazione di una credenziale con valori di attributo utilizzando l'API

    Creare una credenziale con un attributo standard e aggiungere due attributi aggiuntivi con valori di input utente.

    Prerequisiti

    Nota: Puoi visualizzare in Control Room APIs, ma Community Edition la funzionalità API è limitata. È necessaria Automation 360 un'edizione con licenza per accedere alla funzionalità completa delle API.
    • Utilizza l'API di autenticazione per generare un token Web JSON. Vedere API di autenticazione.
    • Tutti i ruoli dispongono dell'autorizzazione Manage my credentials and lockers (Gestisci le mie credenziali e gli armadietti) necessaria per configurare le credenziali e gli attributi. Non sono necessarie autorizzazioni aggiuntive per utilizzare questo endpoint.
    In questo esempio, si configura una credenziale con tre attributi per contenere nome host, nome utente e password dell'e-mail.

    Procedura

    1. Aggiungere il token di autenticazione all'intestazione della richiesta.
    2. Crea una credenziale. Utilizzare il metodo POST e l'URL dell'endpoint: <your_control_room_url>/v2/credentialvault/credentials.
      Corpo della richiesta: Questa richiesta di esempio include i seguenti parametri obbligatori:
      • userProvided: un valore booleano che configura se l'attributo richiede l'input di un utente (true) o è standard per tutti gli utenti (false).
      • masked (mascherato): un valore booleano che configura se il valore dell'attributo è mascherato con asterischi (true) o è visibile agli utenti (false).
      {
        "name": "Email",
        "attributes": [
        	{
            "name": "hostname",
            "userProvided": false,
            "masked": false
          } 	
        ]
      }
    3. Inviare la richiesta.
      Corpo della risposta: In una richiesta riuscita, questo endpoint restituisce i seguenti dati:
      • id: un identificatore numerico univoco per la credenziale.
      • attributes:id: un identificatore numerico univoco per l'attributo.
      {
          "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"
      }
      L'API REST risponde a ogni richiesta con un codice di risposta HTTP. Per i codici di risposta, consulta Codici di risposta API.
    4. Assegnare un valore standard all'attributo hostname alla credenziale. Utilizzare il metodo POST e l'URL dell'endpoint:<your_control_room_url>/{credentialId}v2/credentialvault/credentials//attributevalues.
      {
        "list": [
          {
            "credentialAttributeId": "3335",
            "value": "mail.example.com"
          }
        ]
      }
    5. Inviare la richiesta.
      Corpo della risposta:
      {
        "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"
          }
        ]
      }
    6. Aggiungi gli attributi nome utente e password alle credenziali e-mail. Utilizza il metodo PUT e l'URL dell'endpoint:<your_control_room_url>/v2/credentialvault/credentials/{credentialId}.
      Corpo della richiesta: Poiché hai specificato l'ID credenziale nell'URL della richiesta, non è necessario includere l'ID o il nome della credenziale nel corpo della richiesta. In questo corpo della richiesta di esempio, gli attributi nome utente e password sono configurati con valori che accettano un input diverso da ciascun utente. Inoltre, l'attributo password è configurato per mascherare il valore immesso con asterischi.
      {
          "attributes": [
        	{
            "name": "username",
            "userProvided": true,
            "masked": false
          },
           {
            "name": "password",
            "userProvided": true,
            "masked": true
          }	
        ]
      }
    7. Inviare la richiesta.
      Corpo della risposta: Il corpo della risposta restituisce la credenziale con i dettagli dei tre attributi.
      {
          "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"
      }

    Fasi successive

    Se stai seguendo la procedura per configurare il tuo Credential Vault, procedi come segue: Assegna credenziali locker all'API.
    Invia feedback