Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

API d'authentification

  • Mis à jour le : 5/06/2020
    • 11.3.x
    • Exploration
    • Enterprise
    • Docs API

API d'authentification

Utilisez l’API d’authentification pour générer, actualiser et gérer les jetons JWT nécessaires à l’autorisation dans toutes les API de la Enterprise Control Room.

Le JWT est une chaîne de 703 caractères.
{
  "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",  . . . 
}

auth

POST http://<your_control_room_url>/v1/authentication
Paramètres du corps :
{
  "username": "string",
  "password": "string",
  "apiKey": "string",
  "mfaCode": 0
}
Faites une demande POST pour générer un jeton JWT.
  • Le nom d’utilisateur de l’utilisateur Automation Anywhere.
  • Le mot de passe de l'utilisateur Automation Anywhere.
  • La apiKey est nécessaire à la configuration de l’authentification unique (SSO). Elle peut également être utilisée en lieu et place du mot de passe pour les utilisateurs affectés au rôle de génération de clés API de la Création et attribution du rôle de génération de clés API.
  • Le mfaCode est nécessaire pour les utilisateurs dont le rôle a été activé pour l’authentification à deux facteurs (2FA). Reportez-vous à la rubrique Activation de l’authentification à deux facteurs.
    Remarque : Nous vous recommandons de désactiver 2FA dans un rôle ou de créer un rôle distinct qui n’utilise pas 2FA pour une utilisation dans des scripts ou d’autres environnements programmatiques. Vous devez utiliser le nom d’utilisateur et la Clé API pour vous authentifier lorsque vous faites des demandes d’API via un programme. Pour plus de sécurité, évitez d’utiliser des mots de passe au format texte brut.
Remarque : Par défaut, les jetons d’authentification expirent au bout de 20 minutes.
Un jeton JWT est requis dans l’en-tête des autres API de la Enterprise Control Room. Tous les paramètres ne sont pas obligatoirement requis pour générer un jeton d’authentification. Pour de plus amples informations, consultez les exemples énumérés ici.
Remarque :

Mécanisme de négociation GSS-API simple et protégé (SPNEGO)

Vous pouvez utiliser le mécanisme SPNEGO, à prononcer « spenay-go », lorsque votre Enterprise Control Room est correctement configurée grâce aux fonctions d’authentification suivantes :
  • Mode d’authentification Active Directory (AD)
  • AD est compatible avec Kerberos

Dans le cas d’une Enterprise Control Room bénéficiant d’un SPNEGO correctement configuré, il n’est pas nécessaire que les utilisateurs saisissent leur nom d’utilisateur ni leur mot de passe pour générer un jeton JWT.

Exemple d’URL d’API d’authentification SPNEGO :https://<your_control_room_url/v1/authentication/SPNEGO

GET http://<your_control_room_url>/v1/authentication/token/{token}
Paramètre URL :
Le jeton que vous validez.
Remarque : Le jeton est transmis en tant que paramètre dans l’URL. Il n’y a aucun paramètre pour le corps de demande.

Pour plus d'informations sur cette tâche, reportez-vous à Valider un jeton d'authentification.

POST http://<your_control_room_url>/v1/authentication/token
Paramètre du corps :
Un jeton d’actualisation vous permet d’obtenir un nouveau jeton sans collecte ni authentification systématique des informations d’identification chaque fois qu’un jeton expire.
{
  "token": "string"
}

Cliquez sur Actualisation d’un jeton d’authentification pour consulter un exemple détaillé de cette API.

POST http://<your_control_room_url>/v1/authentication/logout
Paramètre d’en-tête :
Expire immédiatement le jeton que vous ajoutez à l’en-tête de la demande.
POST 'http://<your_control_room_url>/v1/authentication/logout'
-H 'X-Authorization: <access_token> 

Cliquez sur Déconnecter immédiatement un jeton d’authentification (expiration) pour consulter un exemple détaillé de cette API.

POST http://<your_control_room_url>/v1/authentication/app/login
L’API .../authentication/app/login est une API d’authentification service à service utilisée par les applications Automation Anywhere prises en charge en interne. Cette API ne peut pas être prise en charge par les utilisateurs externes.
Envoyer le commentaire