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 ce tableau ou le type d'authentification en général 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.
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 (Connector Builder) 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 prises en charge sont les suivantes :

• 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 toute personne utilisant votre connecteur doit s'authentifier. Il s’agit de vous pendant que vous construisez le connecteur, mais aussi d’autres personnes qui finissent par utiliser votre création.

Authentification de base

1. Sélectionnez l'option Modifier (Edit) sous la colonne Action pour configurer chaque propriété. Le nom d' utilisateur et le mot de passe sont disponibles par défaut.

2. Sélectionnez Ajouter un paramètre (Add parameter ) si vous souhaitez ajouter un autre champ à utiliser lors de l'authentification :

   • Nom complet ( Display name ) : affiché à l'utilisateur lors de la connexion.
   • Type (Type) : définit le champ d'entrée dans la boîte de dialogue de connexion. Sélectionnez une option dans le menu déroulant : vrai/faux (true/false), mot de passe, test, oui/non (yes/no).
   • Demander à l'utilisateur (Ask the user) : sélectionnez Oui ( Yes ) lorsque l'entrée de l'utilisateur est requise.
   • Valeur (Value) : utilisez ce champ pour définir une valeur par défaut.
   • Texte de l'indice – Guide de l'utilisateur pour le champ d'entrée.
   • Nom du fournisseur ( Provider name ) - Clé technique de l'appel d'API.
   • Envoyer au fournisseur en tant que type : la façon dont l'API reçoit la valeur. Sélectionnez une option dans le menu déroulant : configuration, en-tête, chemin, corps, requête, formulaire. Valeur par défaut : header.
   
   

   

   
   
3. Sélectionnez Enregistrer ( Save) pour enregistrer votre nouveau paramètre d'authentification.
4. Utilisez l'option Rétablir les paramètres par défaut ( Reset to default ) si vous souhaitez réinitialiser votre authentification aux valeurs d'origine pour l'authentification de base. Cette opération ne peut être annulée.

Code d’autorisation OAuth 2.0

Pour utiliser le code d'autorisation OAuth 2.0, vous devez créer une application OAuth dans l'application à laquelle vous souhaitez vous intégrer et y récupérer les informations d'identification nécessaires à la configuration de votre connecteur.

Configurez les champs suivants :

• ID de client
• Secret du client
• Portée
• URL d'autorisation
• URL de jeton
• URL du jeton d'actualisation
• En-tête de base
• URL de révocation du jeton

• Intervalle d’actualisation OAut

  Remarque : Les URL d'autorisation, de jeton et de jeton d'actualisation doivent être disponibles dans la documentation de l'API de l'application.

Code d'autorisation OAuth 2.0 avec PKCE

Le code d’autorisation OAuth2.0 avec PKCE est identique à la méthode du code d’autorisation OAuth2.0, mais il inclut également le champ Méthode de défi de code OAuth2 PKCE .

Identifiants du client OAuth 2.0

Pour les Informations d'identification du client OAuth 2.0, vous devez configurer les champs suivants :

• ID de client
• Secret du client
• Portée
• URL de jeton
• En-tête de base

• Intervalle d’actualisation OAut

Clé API

Utilisez cette option pour l'intégration avec des applications qui nécessitent une clé API pour effectuer des appels d'API.

Définissez le champ Clé API (API Key ) sur la valeur souhaitée.

Jeton d’accès personnel

Utilisez cette option pour l'intégration avec des applications qui nécessitent un jeton de porteur pour effectuer des appels d'API.

Définissez le champ Jeton d' accès personnel (Personal Access Token ) sur votre jeton du porteur.

Personnalisé

Vous pouvez également configurer une authentification personnalisée en utilisant les champs de votre choix.

Aucune authentification

Utilisez cette option si vous n'avez pas besoin que les utilisateurs s'authentifient pour utiliser le connecteur.