Leggi e rivedi la documentazione di Automation Anywhere

Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

Configurare una credenziale con valori di attributi tramite API

  • Aggiornato: 2021/12/16
    • Automation 360 v.x
    • Esplora
    • Spazio di lavoro RPA

Configurare una credenziale con valori di attributi tramite API

Creare una credenziale con un attributo standard e aggiungere due attributi supplementari con valori inseriti dall'utente.

Prerequisiti

Nota: È possibile visualizzare il Control Room APIs nel file Community Editionma le funzionalità dell'API sono limitate. È necessario disporre di una licenza Automation 360 Edition per accedere a tutte le funzionalità delle API.
  • Tutte le chiamate API devono contenere un token di autenticazione nell'intestazione della richiesta. Usare la funzione Autenticazione per generare un token web JSON. Vedi API di autenticazione.
  • Tutti i ruoli hanno la possibilità di Gestisci le mie credenziali e i miei armadietti necessaria per configurare le credenziali e gli attributi. Non sono necessarie ulteriori autorizzazioni per utilizzare questo endpoint.
In questo esempio, si configura una credenziale con tre attributi per contenere il nome host dell'e-mail, il nome utente e la password.

Procedura

  1. Aggiungere il token di autenticazione all'intestazione della richiesta.

Creare una credenziale:

  1. Utilizzare il metodo POST e l'URL dell'endpoint:<vostro_control_room_url>/v2/credentialvault/credenziali.
    Corpo della richiesta: Questo esempio di richiesta include i seguenti parametri obbligatori:
    • fornito dall'utente: un valore booleano che configura se l'attributo richiede l'input dell'utente (true) o è standard per tutti gli utenti (false).
    • mascherato: un valore booleano che configura se il valore dell'attributo è mascherato con asterischi (true) o sia visibile agli utenti (falso).
    {
      "name": "Email",
      "attributes": [
      	{
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 	
      ]
    }
  2. Inviare la richiesta.
    Corpo della risposta: In caso di richiesta andata a buon fine, questo endpoint restituisce i seguenti dati:
    • id: un identificatore numerico univoco per la credenziale.
    • attributi:id: un identificatore numerico unico 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, vedere Codici di risposta API.

Assegnare un valore standard all'attributo hostname della credenziale:

  1. Utilizzare il metodo POST e l'URL dell'endpoint:<vostro_control_room_url>/v2/credentialvault/credenziali/{credentialId}/attributivalori.
    {
      "list": [
        {
          "credentialAttributeId": "3335",
          "value": "mail.example.com"
        }
      ]
    }
  2. 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"
        }
      ]
    }
  3. Aggiungere il nome utente e password agli attributi Email alla credenziale Email. Utilizzare il metodo PUT e l'URL dell'endpoint:<vostro_control_room_url>/v2/credentialvault/credenziali/{credenzialeId}.
    Nota: È necessario includere nella richiesta gli attributi esistenti insieme a quelli nuovi, altrimenti gli attributi attuali verranno sovrascritti.
    Corpo della richiesta: Poiché l'ID della credenziale è stato specificato nell'URL della richiesta, non è necessario includere l'ID o il nome della credenziale nel corpo della richiesta. In questo esempio di corpo della richiesta, il nome nome utente e password sono configurati con valori che accettano un input diverso da ogni utente. Inoltre, l'attributo password è configurato per mascherare il valore inserito con degli asterischi.
    {
        "attributes": [
      	{
          "name": "username",
          "userProvided": true,
          "masked": false
        },
         {
          "name": "password",
          "userProvided": true,
          "masked": true
        },
         {
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 		
      ]
    }
  4. 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 si sta seguendo la procedura per configurare il proprio Credential Vault, procedere come segue: Assegnare la credenziale a locker API.
Invia feedback