S'authentifier avec les cartes du connecteur API

Aperçu

Utilisez les cartes de fonction Connecteur API pour établir des connexions authentifiées vers des services tiers.

Arrière-plan

Si un connecteur prédéfini n'est pas disponible, vous pouvez utiliser les cartes Connecteur API pour effectuer une requête vers un service tiers, puis analyser la réponse dans votre flux. Vos identifiants sont stockés de manière sécurisée, et un en-tête est créé automatiquement à l'aide de l'un des types d'authentification fournis.

Méthodes HTTP

Avec les fonctions Connecteur API, vous pouvez créer des connexions authentifiées en utilisant l'une des méthodes HTTP répertoriées. Les méthodes suivantes exécutent le type de requête spécifié et renvoient le résultat de la requête et les en-têtes de réponse :

  • Delete
  • Get
  • Patch
  • Post
  • Put

Les méthodes Fermer et Requête brute diffèrent légèrement des méthodes précédentes, comme décrit :

  • Fermer : envoie une réponse à l'appelant, puis ferme la connexion HTTP. Utilisez cette fonction lorsque l'appelant n'a pas besoin d'attendre la fin du flux, ou lorsque vous devez éviter un délai d'expiration de connexion.
  • Requête brute : Effectue une requête HTTP brute, avec un contrôle total sur la requête et la réponse. Cela est utile pour appeler des services XML et pour d'autres cas d'utilisation HTTP avancés.

Types d'authentification

Suivez ces étapes pour configurer votre authentification :

  1. Dans le générateur de flux, sélectionnez Fonction > Connecteur API.

  2. Sélectionnez une carte Connecteur API.

  3. Cliquez sur le bouton + Nouvelle connexion pour ouvrir la boîte de dialogue Nouvelle connexion.

  4. Saisissez un surnom pour votre connexion.

    Comme les cartes Connecteur API peuvent être utilisées avec plusieurs connexions, saisissez un nom détaillé pour distinguer chaque connexion.

    Décrivez le service appelé, le type d'authentification et une référence au compte utilisé. Par exemple, JIRA Service Management - OAuth - service_account.

  5. Sélectionnez votre type d'authentification dans la liste déroulante. Les cartes Connecteur API prennent en charge les types d'authentification suivants : Basic, En-tête personnalisé, OAuth, Identifiants client ou Aucun. Consultez Types d'authentification.

  6. Saisissez les valeurs requises pour votre type d'authentification.

  7. Cliquez sur Créer.

Options de type d'authentification

Basic

Un schéma d'authentification simple intégré au protocole HTTP. Les valeurs requises sont le Nom d'utilisateur et le Mot de passe pour l'application tierce appelée.

Workflows Okta envoie des requêtes HTTP avec l'en-tête Autorisation contenant le mot Basic suivi d'un espace et d'une chaîne encodée en base64 <username>:<password>.

OAuth

OAuth 2.0 est un protocole qui vous permet d'accorder un accès limité aux ressources d'un site tiers sans exposer vos identifiants. Avant de commencer le processus OAuth, vous devez d'abord enregistrer une nouvelle app auprès du service, en incluant des informations telles que le nom de l'application et l'URL du site web.

De plus, vous devez enregistrer un URI de redirection à utiliser pour rediriger l'authentification vers Workflows. Utilisez les URI de redirection suivantes pour vous connecter respectivement aux Preview Orgs et organisations de production Workflows Okta : https://oauth.workflows.oktapreview.com/oauth/httpfunctions/cb et https://oauth.workflows.okta.com/oauth/httpfunctions/cb.

  • Chemin d'autorisation : Le chemin d'autorisation du service. Par exemple, https://example.com/oauth2/v1/authorize.

    Si votre implémentation OAuth nécessite d'autres paramètres de requête, vous pouvez les ajouter ici. Faites suivre le chemin autorisation par le caractère ?, puis ajoutez vos paramètres en tant que paires key=value séparées par le caractère &.

  • Chemin du jeton d'accès : L'URI où Workflows peut échanger un code d'autorisation contre des jetons d'accès et d'actualisation.

  • Permission : Spécifie le niveau d'accès accordé à Workflows. Vous pouvez saisir plusieurs permissions séparées par des espaces ou des virgules, mais cela dépend du service. Consultez la documentation API de votre service pour vérifier si des permissions spéciales sont nécessaires pour récupérer un jeton d'actualisation (comme refresh_token ou offline_access).

  • ID client : une chaîne exposée publiquement fournie par le service qui identifie l'application OAuth et est utilisée pour créer des URL d'autorisation.

  • Secret client : une valeur privée fournie par le service utilisée pour authentifier l'identité de l'application auprès du service.

Identifiants client

Identifiants client Identifiants client est un type d'autorisation du protocole OAuth 2.0. Cela vous permet d'accorder un accès complet et non spécifique à un utilisateur aux ressources tierces. Comme pour l'option OAuth, vous devez d'abord enregistrer une nouvelle app auprès du service, en incluant des informations telles que le nom de l'application et l'URL du site web.

  • Chemin du jeton d'accès : L'URI où Workflows peut échanger un code d'autorisation contre des jetons d'accès et d'actualisation. Par exemple, https://example.com/oauth2/v1/token.

  • ID client : une chaîne exposée publiquement fournie par le service qui identifie l'application OAuth et est utilisée pour créer des URL d'autorisation.

  • Secret client : une valeur privée fournie par le service utilisée pour authentifier l'identité de l'application auprès du service.

Personnalisé

Cette option vous permet de créer un nom et une valeur d'en-tête personnalisés.

  • Nom de l'en-tête : nom personnalisé à transmettre au service. Par exemple, un service peut exiger api_key comme nom d'en-tête et la clé elle-même comme valeur.

  • Valeur de l'en-tête : la valeur à transmettre au service avec le nom de l'en-tête.

Aucun

Utilisez cette option pour créer manuellement votre connexion lorsqu'aucune des autres options ne s'applique. Elle peut également être utilisée pour accéder à des points de terminaison non authentifiés.