Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

Configurer une information d’identification avec des valeurs d’attribut à l’aide de l’API

  • Mis à jour le : 1/31/2021
    • Automation 360 v.x
    • Exploration
    • Espace de travail RPA

Configurer une information d’identification avec des valeurs d’attribut à l’aide de l’API

Créez une information d’identification avec un attribut standard et ajoutez deux attributs supplémentaires avec des valeurs d’entrée utilisateur.

Prérequis

Remarque : Vous pouvez afficher l’Control Room APIs dans la Édition Community, mais la fonctionnalité de l’API est limitée. Vous avez besoin d'une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalité API.
  • Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d'authentification.
  • Tous les rôles disposent de l’autorisation Gérer mes informations d’identification et mes casiers qui est nécessaire pour configurer les informations d’identification et les attributs. Aucune autorisation supplémentaire n’est nécessaire pour utiliser ce point de terminaison.
Dans cet exemple, vous configurez une information d’identification avec trois attributs pour contenir le nom d’hôte, le nom d’utilisateur et le mot de passe de l’e-mail.

Procédure

  1. Ajoutez le jeton d’authentification à l’en-tête de la requête.
  2. Créez une information d’identification. Utilisez la méthode POST et l’URL du point de terminaison : <your_control_room_url>/v2/credentialvault/credentials.
    Corps de requête : Cet exemple de demande inclut les paramètres requis suivants :
    • userProvided : une valeur booléenne qui configure si l’attribut nécessite l’entrée d’un utilisateur (vrai) ou est standard pour tous les utilisateurs (faux).
    • masked : une valeur booléenne qui configure si la valeur d’attribut est masquée par des astérisques (vrai) ou visible par les utilisateurs (faux).
    {
      "name": "Email",
      "attributes": [
      	{
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 	
      ]
    }
  3. Envoyez la requête.
    Corps de réponse : Dans une requête réussie, ce point de terminaison renvoie les données suivantes :
    • id : un identifiant numérique unique pour l’information d’identification.
    • attributes:id : un identifiant numérique unique pour l’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"
    }
    L’API REST répond à chaque requête par un code de réponse HTTP. Pour les codes de réponse, consultez Codes de réponse de l'API.
  4. Attribuez une valeur standard à l’attribut du nom d’hôte aux informations d’identification. Utilisez la méthode POST et l’URL du point de terminaison :<your_control_room_url>/v2/credentialvault/credentials/{credentialId}/attributevalues.
    {
      "list": [
        {
          "credentialAttributeId": "3335",
          "value": "mail.example.com"
        }
      ]
    }
  5. Envoyez la requête.
    Corps de réponse :
    {
      "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. Ajoutez les attributs du nom d’utilisateur et du mot de passe aux informations d’identification de l’e-mail. Utilisez la méthode PUT et l’URL du point de terminaison :<your_control_room_url>/v2/credentialvault/credentials/{credentialId}.
    Corps de requête : Étant donné que vous avez spécifié l’identifiant d’informations d’identification dans l’URL de demande, il n’est pas nécessaire d’inclure l’identifiant ou le nom de l’information d’identification dans le corps de la demande. Dans cet exemple de corps de requête, les attributs de nom d’utilisateur et de mot de passe sont configurés avec des valeurs qui acceptent une entrée différente de chaque utilisateur. De plus, l’attribut de mot de passe est configuré pour masquer la valeur saisie avec des astérisques.
    {
        "attributes": [
      	{
          "name": "username",
          "userProvided": true,
          "masked": false
        },
         {
          "name": "password",
          "userProvided": true,
          "masked": true
        }	
      ]
    }
  7. Envoyez la requête.
    Corps de réponse : Le corps de la réponse renvoie les informations d’identification avec les détails des trois attributs.
    {
        "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"
    }

Étapes suivantes

Si vous suivez les étapes pour configurer votre Credential Vault, procédez de la manière suivante : API Attribuer des informations d’identification à la casier.
Envoyer le commentaire