Configuration de l'authentification

L'un des principaux piliers de la création d'un connecteur consiste à identifier et à intégrer correctement sa configuration d'authentification. Si cela est fait correctement, une fois le connecteur publié dans le catalogue Integration Service, les utilisateurs peuvent créer des connexions vers celui-ci, comme avec n'importe quel autre connecteur du catalogue.

Tous les connecteurs réutilisent l'infrastructure d'authentification afin que le flux d'authentification complet et la gestion des connexions puissent être gérés dans une approche unifiée.

Le résultat final de l'authentification est que toute requête ultérieure dans ce connecteur utilise le résultat du processus d'authentification pour chaque appel API. Par exemple, un jeton porteur est envoyé dans les en-têtes à chaque appel API :

Le générateur de connecteurs prend en charge les normes de l'industrie suivantes grâce à une configuration simple plutôt qu'un codage complet :

• Code d'autorisation OAuth 2.0
• Code d'autorisation OAuth 2.0 avec PKCE
• Informations d'identification du client OAuth 2.0
• Basique
• Clé API
• Jeton d’accès personnel (PAT)
• Personnalisé
• Aucune authentification

Étant donné que le générateur de connecteurs est lié à l'infrastructure Integration Service, la définition de votre configuration d'authentification est désormais une question de configuration plutôt qu'un processus complexe. Cela signifie que l'infrastructure gère les échanges de jetons, les actualisations et toute autre tâche de ce type. Le générateur de connecteurs utilise par défaut le code d'autorisation OAuth 2.0, car il s'agit de l'approche la plus courante des fournisseurs pour gérer l'authentification.

La page d'authentification est constituée de trois composants :

1. Le type d'authentification, qui guide la façon dont l'infrastructure d'authentification reflète une validation supplémentaire pour PKCE, un échange de jetons complet (pour OAuth), etc. En outre, il reconfigure également la table avec des propriétés inférieures afin que les propriétés requises soient décrites.
   

   

   
   
2. La table des propriétés peut être modifiée avec des paramètres personnalisés et/ou en modifiant les paramètres existants. Selon le type d'authentification sélectionné dans le menu déroulant, certains champs peuvent être obligatoires et spécifiés en rouge.
   Remarque : la modification de ces propriétés dans cette table ou le type d'authentification invalide la connexion que vous avez peut-être déjà créée dans le générateur de connecteurs. Il n'y a qu'une seule connexion au moment de la conception, et elle doit être configurée et testée par rapport à la dernière configuration d'authentification.

   Si vous mettez à jour vos paramètres d'authentification, les connexions existantes échoueront. Vous devez créer une nouvelle connexion et mettre à jour vos processus pour utiliser la nouvelle connexion.
3. L'écran Authentification (Authentication) est généré automatiquement en fonction de la configuration que vous avez fournie. Ce que vous voyez lors de la configuration dans le générateur de connecteurs, c'est exactement le résultat final que les utilisateurs de votre package d'activités verront.
   
   
   
   

Configuration de la table d'authentification

Sans tenir compte du Type d'authentification, la table des propriétés chargée identifie deux éléments :

1. Ce que l’utilisateur voit dans l’écran d’authentification.
2. La façon dont l'authentification est gérée par l'infrastructure d'authentification.

• Chaque élément de ligne de la table représente une propriété qui peut ou non être remplacée par l'utilisateur. Pour présenter un champ donné à l'écran, il doit être marqué comme Demander à l'utilisateur - Oui (Ask the user - Yes).
• Chaque élément de ligne a un Nom (Name) et un Nom d'affichage ( Display name). Le nom est ce que le fournisseur attend pour la configuration technique, et ce dernier est important pour demander cette entrée à l'utilisateur sur l'écran d'authentification.
• Chaque élément de ligne contient un menu d'actions qui permet de modifier la propriété beaucoup plus de détails. C'est ici que vous pouvez indiquer qu'une propriété donnée doit être envoyée comme en-tête. Pour en savoir plus, consultez la section Clé API .

Type d’authentification

Dans l'onglet Authentification , vous configurez le type d'authentification pour votre connecteur. Les options suivantes sont prises en charge :

• Code d'autorisation OAuth 2.0
• Code d'autorisation OAuth 2.0 avec PKCE
• Informations d'identification du client OAuth 2.0
• Basique
• Clé API
• Jeton d’accès personnel (PAT)
• Personnalisé
• Aucune authentification

Remarque :

Lors de la configuration de l'authentification, vous configurez la façon dont les utilisateurs de votre connecteur doivent s'authentifier. Il s'agit de vous pendant que vous créez le connecteur, mais il peut également s'agir d'autres utilisateurs qui finissent par utiliser votre création.

Code d'autorisation OAuth 2.0

Vue d'ensemble (Overview)

Le code d'autorisation OAuth 2.0 est l'un des protocoles d'authentification les plus couramment utilisés.

Champs d’authentification

Les champs d'URL tels qu' URL d'autorisation (Authorization URL) et URL de jeton (Token URL) n'héritent pas de l'URL de base du connecteur et nécessitent l'URL complète. Cela permet les cas d'utilisation où un fournisseur utilise une URL de base différente pour l'authentification de celle du reste de l'API.

Champs obligatoires

Remarque : L'ID de client et la clé secrète du client sont souvent générés à partir du fournisseur d'API. Veuillez consulter la documentation du fournisseur pour savoir comment générer ces valeurs dans le cadre de l'authentification.

Champ	Description
ID de client	Identificateur d'application généré par le fournisseur.
Secret du client	Clé secrète d'application générée par le fournisseur.
URL d'autorisation	URL qui redirige l'utilisateur pour terminer le processus d'authentification. Renvoie un code d'autorisation.
URL de jeton	URL utilisée par UiPath pour échanger le code d'autorisation contre un jeton.

Champs supplémentaires

Champ	Description
Portée	Ajoutez les étendues nécessaires pour un connecteur en séparant chaque étendue (c'est-à-dire read write openid).
URL du jeton d'actualisation	URL nécessaire pour générer un nouveau jeton d'accès si un jeton de réactualisation est également renvoyé. Il s'agit souvent de la même URL que celle utilisée pour l' URL du jeton ( Token URL).
URL de révocation du jeton	URL nécessaire pour révoquer le jeton d'accès.
Intervalle d’actualisation OAut	Durée de validité du jeton d'accès. La valeur par défaut est de 3 600 secondes ou 60 minutes.
Nom de connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée.
En-tête de base	Indique si l'ID client et la clé secrète sont envoyés sous forme de valeur encodée en Base64 dans l'en-tête Authorization . Valeur booléenne (true/false) ; la valeur par défaut est True.

Mode de fonctionnement

Une fois toutes les valeurs de champ ajoutées ou configurées pour le connecteur, UiPath® vous guide automatiquement à travers les étapes nécessaires pour terminer le flux d’authentification. UiPath prend en charge le protocole et, s'il est fourni avec un URI de jeton d'actualisation, régénère automatiquement les jetons d'accès en arrière-plan selon les besoins. Cela permet de maintenir la connexion active et fonctionnelle tant que le jeton d’actualisation sous-jacent est valide.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête d'autorisation automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {yourToken}'

Code d'autorisation OAuth 2.0 avec PKCE

Vue d'ensemble (Overview)

Le code d'authentification OAuth 2.0 avec PKCE (Proof Key for Code Exchange) est un protocole d'authentification courant qui est exploité en grande partie par des applications à page unique, des applications qui ne peuvent pas stocker en toute sécurité une clé secrète client ou des applications qui ne peuvent pas garantir la récupération sécurisée d'un code d'autorisation.

Champs d’authentification

Les champs d'URL tels qu' URL d'autorisation (Authorization URL) et URL de jeton (Token URL) n'héritent pas de l'URL de base du connecteur et nécessitent l'URL complète. Cela permet les cas d'utilisation où un fournisseur utilise une URL de base différente pour l'authentification de celle du reste de l'API.

Champs obligatoires

Remarque : L'ID de client et la clé secrète du client sont souvent générés à partir du fournisseur d'API. Veuillez consulter la documentation du fournisseur pour savoir comment générer ces valeurs dans le cadre de l'authentification.

Champ	Description
ID de client	Identificateur d'application généré par le fournisseur.
Secret du client	Clé secrète d'application générée par le fournisseur.
URL d'autorisation	URL qui redirige l'utilisateur pour terminer le processus d'authentification. Renvoie un code d'autorisation.
URL de jeton	URL utilisée par UiPath pour échanger le code d'autorisation contre un jeton.

Champs supplémentaires

Champ	Description
Portée	Ajoutez les étendues nécessaires pour un connecteur en séparant chaque étendue (c'est-à-dire read write openid).
URL du jeton d'actualisation	URL nécessaire pour générer un nouveau jeton d'accès si un jeton de réactualisation est également renvoyé. Il s'agit souvent de la même URL que celle utilisée pour l' URL du jeton ( Token URL).
Méthode de défi de code OAuth2 PKCE	Méthode utilisée pour générer le défi. Peut être S256 ou plain (recommandé : S256).
URL de révocation du jeton	URL nécessaire pour révoquer le jeton d'accès.
Intervalle d’actualisation OAut	Durée de validité du jeton d'accès. La valeur par défaut est de 3 600 secondes ou 60 minutes.
Nom de connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée.
En-tête de base	Indique si l'ID client et la clé secrète sont envoyés sous forme de valeur encodée en Base64 dans l'en-tête Authorization . Valeur booléenne (true/false) ; la valeur par défaut est True.

Mode de fonctionnement

Une fois toutes les valeurs de champ ajoutées ou configurées pour le connecteur, UiPath® vous demande automatiquement de suivre les étapes nécessaires pour terminer le flux d’authentification. UiPath prend en charge le protocole et, s'il est fourni avec un URI de jeton d'actualisation, régénère automatiquement les jetons d'accès en arrière-plan selon les besoins. Cela permet de maintenir la connexion active et fonctionnelle tant que le jeton d’actualisation sous-jacent est valide.

UiPath fournit la chaîne de défi nécessaire pour l'autorisation basée sur PKCE, seule la méthode de défi de code OAuth2 PKCE est requise.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête d'autorisation automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

Informations d'identification du client OAuth 2.0

Vue d'ensemble (Overview)

Les informations d'identification du client OAuth 2.0 permettent de renvoyer un jeton d'accès accordant l'accès aux ressources protégées à l'aide d'informations d'identification spécifiques à l'application qui accordent l'autorisation nécessaire. Les informations d'identification du client sont souvent utilisées pour les applications de machine à machine (M2M) et ne sont généralement pas représentatives des autorisations de l'utilisateur.

Champs d’authentification

Les champs d'URL tels que URL de jeton (Token URL) n'héritent pas de l'URL de base du connecteur et nécessitent l'URL complète. Cela permet les cas d'utilisation où un fournisseur utilise une URL de base différente pour l'authentification de celle du reste de l'API.

Champs obligatoires

Remarque : L'ID de client et la clé secrète du client sont souvent générés à partir du fournisseur d'API. Veuillez consulter la documentation du fournisseur pour savoir comment générer ces valeurs dans le cadre de l'authentification.

Champ	Description
ID de client	Identificateur d'application généré par le fournisseur.
Secret du client	Clé secrète d'application générée par le fournisseur.
URL de jeton	URL utilisée pour récupérer le jeton d'accès.

Champs supplémentaires

Champ	Description
Portée	Ajoutez les étendues nécessaires pour un connecteur en séparant chaque étendue (c'est-à-dire read write openid).
Intervalle d’actualisation OAut	Durée de validité du jeton d'accès. La valeur par défaut est de 3 600 secondes ou 60 minutes.
Nom de connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée.
En-tête de base	Indique si l'ID client et la clé secrète sont envoyés sous forme de valeur encodée en Base64 dans l'en-tête Authorization . Valeur booléenne (true/false) ; la valeur par défaut est True.

Mode de fonctionnement

Une fois toutes les valeurs de champ ajoutées ou configurées pour le connecteur, UiPath® génère une demande d’autorisation, faisant passer par les informations d’identification nécessaires pour générer un jeton d’accès. Étant donné que les informations d'identification du client OAuth 2.0 sont destinées aux applications M2M, vous ne voyez que la page d'autorisation UiPath initiale et vous n'aurez aucune autre redirection.

Une fois qu'un flux d'autorisation réussi est détecté, UiPath maintient la connexion tant que les informations d'identification fournies sont valides.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête d'autorisation automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

Authentification de base

Vue d'ensemble (Overview)

Le type d'authentification de base vous permet de définir un nom d'utilisateur et un mot de passe qui sont ensuite encodés en Base64 et comportant le préfixe Basic. Le nom d'utilisateur et le mot de passe, qui peuvent être modifiés, sont utilisés dans toutes les requêtes du connecteur comme valeur de l'en-tête d'autorisation.

Champs d’authentification

Champ	Description
Nom d'utilisateur (Username)	La première valeur dans les deux parties délimitée et la valeur de l’en-tête Authorization encodée en Base64.
Mot de passe (Password)	La deuxième valeur dans les deux parties délimitée et la valeur de l'en-tête Authorization encodée en Base64.
Nom de connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée.

Mode de fonctionnement

Lorsqu’il est fourni avec les valeurs de nom d’utilisateur et de mot de passe, UiPath® combine et sépare les valeurs par deux points, les encode en Base64 et ajoute le préfixe Basic pour générer une valeur d’en-tête Authorization (par ex. Authorization: Basic base64(username:password)). Cette valeur d'en-tête est transmise dans chaque requête en tant que moyen d'authentification.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête d'autorisation automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Basic base64(username:password)'

Clé API

Vue d'ensemble (Overview)

Certains fournisseurs proposent une clé API comme forme d’authentification pour accéder à leurs ressources API. Dans Générateur de connecteurs (Connector Builder), ce type d'authentification entraîne l'utilisation d'un en-tête 'X-Acess-Token: <provider_api_key>' qui est transmis dans les requêtes du connecteur.

Champs d’authentification

Champ	Description
Clé API	La clé API générée par le fournisseur d'API à utiliser comme valeur de l'en-tête X-Access-Token sur toutes les requêtes du connecteur.
Nom de la connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée

Mode de fonctionnement

Lorsque vous utilisez la valeur de clé API générée par le fournisseur pour le paramètre Clé API dans Paramètres - Authentification, chaque requête effectuée pour ce connecteur comprend un en-tête X-Access-Token avec la clé API fournie comme valeur d'en-tête.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête X-Access-Token automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'X-Access-Token: {yourtoken}'

Jeton d’accès personnel

Vue d'ensemble (Overview)

Certains fournisseurs fournissent des jetons d'accès non expirables et utilisent le modèle d'en-tête Authorization: {access_token} pour authentifier les requêtes. La méthode d'authentification PAT vous permet de fournir le jeton d'accès nécessaire et applique les en-têtes précédemment répertoriés, mais ne conserve pas le jeton d'accès s'il expire à un moment donné.

Champs d’authentification

Champ	Description
Jeton d’accès personnel	Le jeton d'accès généré par le fournisseur à utiliser comme valeur dans le champ d'en-tête Authorization sur toutes les requêtes du connecteur. Le champ comporte par défaut le préfixe Bearer du jeton pour s'adapter au modèle d'authentification du porteur.
Nom de connexion	Le nom de la connexion dans UiPath une fois l'authentification terminée.

Mode de fonctionnement

Lorsque vous utilisez la valeur de clé API générée par le fournisseur pour le paramètre Jeton Personal Access dans Paramètres - Authentification, chaque requête effectuée pour ce connecteur comprend un en-tête X-Access-Token avec le jeton d'accès Personnel fourni comme valeur d'en-tête.

Format de demande post-autorisation

Une fois la configuration initiale terminée et qu'une connexion est établie, toutes les demandes effectuées pour ce connecteur ont l'en-tête Authorization automatiquement inclus dans la demande.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: {personal_access_token}'

Personnalisé

Vue d'ensemble (Overview)

L'authentification personnalisée doit être utilisée lorsque la configuration du fournisseur ne suit aucune des normes, mais nécessite l'échange et l'envoi de détails d'authentification à chaque demande.

Champs d’authentification

Les champs d'authentification personnalisés sont fournis avec un paramètre Authorization comme exemple de champ, mais peuvent être personnalisés pour correspondre aux modèles d'authentification du fournisseur d'API.

Tous les paramètres ajoutés à l'authentification depuis l'authentification personnalisée s'appliquent aux requêtes du connecteur.

Remarque : Pour l'instant, l'authentification personnalisée ne vous permet pas de créer un flux d'authentification personnalisé. Elle vous permet de personnaliser les paramètres d'authentification standard appliqués aux requêtes dans le connecteur.

Mode de fonctionnement

Les paramètres ajoutés à la section d'authentification sont automatiquement inclus dans toutes les requêtes du connecteur.

Aucune authentification

L'option Aucune authentification (No authentication) fournit une sélection rapide dans la liste et supprime toutes les propriétés de la table de configuration de l'authentification.

Comment l’utiliser

Utilisez cette option si l'application du fournisseur à laquelle vous vous connectez est disponible sans avoir à vous connecter. Il peut s'agir d'un service public en ligne ou d'une API exposée en interne au sein de l'entreprise. Cela ne nécessite aucun en-tête à envoyer sur les demandes identifiant qui effectue l'appel d'API.

Résultat lors de l'envoi d'une demande

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'