Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

API S'authentifier avec le nom d'utilisateur et la clé API

  • Mis à jour le : 2022/03/04
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA
    • Docs API

API S'authentifier avec le nom d'utilisateur et la clé API

Utilisez cette API pour authentifier l'accès à votre Control Room avec le nom d'utilisateur et la clé API. Une réponse complète réussie génère un jeton Web JSON.Par défaut, un jeton est valide pendant 20 minutes. Ce point de terminaison permet aux utilisateurs de générer le jeton sans avoir besoin du mot de passe de l'utilisateur, par exemple pour les organisations qui utilisent l'authentification unique (SSO). Pour générer le jeton, vous avez besoin d'un nom d'utilisateur et d'une clé API valides pour la Control Room.

Pour générer le jeton, vous avez besoin des éléments suivants :

Demande

POST http://{{localhost}}/v1/authentication
Corps de la demande :
{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}

Paramètres de la demande

Paramètre Type Description
nom d'utilisateur Chaîne Saisissez votre nom d'utilisateur.
Remarque : Si l'utilisateur a activé les sessions multiples, un jeton de session multiple sera généré. Pour plus d'informations sur la connexion multiple, voir Utilisateur multi-connexion.
clé api Chaîne Saisissez votre clé API.
Remarque : Veillez à remplacer tout caractère d'échappement « \ » par « \\ » dans la clé API.

Réponse

{
   "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
   }
}

Paramètres de la réponse

Paramètre Type Description
jeton Chaîne Jeton d'accès généré qui sert d'identifiant de session que votre application utilisera pour effectuer des demandes. Ce jeton est équivalent aux informations d'identification de l'utilisateur et doit être protégé.
utilisateur Objet Objet utilisateur retourné avec tous les détails de l'utilisateur.
  • id : identifiant de l'utilisateur.
  • e-mail : adresse e-mail de l'utilisateur.
  • nom d'utilisateur : nom d'utilisateur de l'utilisateur.
  • domaine : domaine auquel vous êtes connecté.
  • prénom : prénom de l'utilisateur.
  • nom : nom de l'utilisateur.
  • rôles : rôles attribués à l'utilisateur.
  • sysAssignedRoles : rôles attribués par le système.
  • autorisations : autorisations attribuées à l'utilisateur.
  • licenseFeatures : licence attribuée à l'utilisateur.

Insérez le jeton dans l'en-tête des demandes d'API suivantes.

Envoyer le commentaire