Utiliser des connecteurs d’API pour personnaliser et étendre l’inscription en libre-serviceUse API connectors to customize and extend self-service sign-up

Vue d’ensembleOverview

En tant que développeur ou administrateur informatique, vous pouvez utiliser des connecteurs d’API pour intégrer vos flux d’utilisateur d’inscription en libre-service avec des systèmes externes en tirant parti des API web.As a developer or IT administrator, you can use API connectors to integrate your self-service sign-up user flows with external systems by leveraging web APIs. Par exemple, vous pouvez utiliser des connecteurs d’API pour :For example, you can use API connectors to:

  • Intégrer à un flux de travail d’approbation personnalisé.Integrate with a custom approval workflow. Connectez-vous à un système d’approbation personnalisé pour gérer la création de comptes.Connect to a custom approval system for managing account creation.
  • Exécuter une vérification d’identité.Perform identity verification. Utilisez un service de vérification d’identité pour ajouter un niveau supplémentaire de sécurité aux décisions de création de comptes.Use an identity verification service to add an extra level of security to account creation decisions.
  • Valider des données d’entrée utilisateur.Validate user input data. Validez par rapport à des données utilisateur incorrectes ou non valides.Validate against malformed or invalid user data. Par exemple, vous pouvez valider les données fournies par l’utilisateur par rapport à des données existantes dans une banque de données externe ou une liste de valeurs autorisées.For example, you can validate user-provided data against existing data in an external data store or list of permitted values. En cas d’invalidité, vous pouvez demander à un utilisateur de fournir des données valides ou empêcher l’utilisateur de continuer le processus d’inscription.If invalid, you can ask a user to provide valid data or block the user from continuing the sign-up flow.
  • Remplacer des attributs utilisateur.Overwrite user attributes. Reformatez ou attribuez une valeur à un attribut collecté auprès de l’utilisateur.Reformat or assign a value to an attribute collected from the user. Par exemple, si un utilisateur entre le prénom entier en lettres minuscules ou majuscules, vous pouvez modifier sa mise en forme en utilisant une majuscule uniquement pour la première lettre.For example, if a user enters the first name in all lowercase or all uppercase letters, you can format the name with only the first letter capitalized.
  • Exécuter une logique métier personnalisée.Run custom business logic. Vous pouvez déclencher des événements en aval dans vos systèmes ce cloud pour envoyer des notifications Push, mettre à jour des bases de données d’entreprise, gérer des autorisations, auditer des bases de données et effectuer d’autres actions personnalisées.You can trigger downstream events in your cloud systems to send push notifications, update corporate databases, manage permissions, audit databases, and perform other custom actions.

Un connecteur d’API fournit à Azure Active Directory les informations nécessaires pour appeler le point de terminaison d’API en définissant l’URL de point de terminaison HTTP et l’authentification.An API connector provides Azure Active Directory with the information needed to call API endpoint by defining the HTTP endpoint URL and authentication. Une fois que vous avez configuré un connecteur d’API, vous pouvez l’activer pour une étape spécifique dans un flux utilisateur.Once you configure an API connector, you can enable it for a specific step in a user flow. Quand un utilisateur atteint cette étape dans le flux d’inscription, le connecteur d’API est appelé et se matérialise en tant que requête HTTP POST à votre API, en envoyant des informations utilisateur (« revendications ») en tant que paires clé-valeur dans un corps JSON.When a user reaches that step in the sign up flow, the API connector is invoked and materializes as an HTTP POST request to your API, sending user information ("claims") as key-value pairs in a JSON body. La réponse d’API peut affecter l’exécution du flux utilisateur.The API response can affect the execution of the user flow. Par exemple, la réponse d’API peut empêcher un utilisateur de s’inscrire, demander à l’utilisateur d’entre à nouveau des informations ou ajouter les attributs de l’utilisateur.For example, the API response can block a user from signing up, ask the user to re-enter information, or overwrite and append user attributes.

Où activer un connecteur d’API dans un flux utilisateurWhere you can enable an API connector in a user flow

Il existe deux emplacements dans un flux utilisateur où vous pouvez activer un connecteur d’API :There are two places in a user flow where you can enable an API connector:

  • après la connexion avec un fournisseur d’identitéAfter signing in with an identity provider
  • avant la création de l’utilisateurBefore creating the user

Important

Dans ces deux cas, les connecteurs d’API sont appelés lors de l’inscription de l’utilisateur et non de la connexion.In both of these cases, the API connectors are invoked during user sign-up, not sign-in.

après la connexion avec un fournisseur d’identitéAfter signing in with an identity provider

Un connecteur d’API à cette étape du processus d’inscription est appelé immédiatement après que l’utilisateur s’est authentifié auprès d’un fournisseur d’identité (Google, Facebook, Azure AD).An API connector at this step in the sign-up process is invoked immediately after the user authenticates with an identity provider (Google, Facebook, Azure AD). Cette étape précède la page de collection d’attributs, qui est le formulaire présenté à l’utilisateur pour collecter des attributs utilisateur.This step precedes the attribute collection page, which is the form presented to the user to collect user attributes. Voici quelques exemples de scénarios de connecteur d’API que vous pouvez activer à cette étape :The following are examples of API connector scenarios you might enable at this step:

  • Utilisez l’adresse e-mail ou l’identité fédérée que l’utilisateur a fournie pour rechercher des revendications dans un système existant.Use the email or federated identity that the user provided to look up claims in an existing system. Retournez ces revendications à partir du système existant, complétez la page de collection d’attributs, puis rendez-les disponibles pour retourner dans le jeton.Return these claims from the existing system, pre-fill the attribute collection page, and make them available to return in the token.
  • Vérifiez si l’utilisateur est inclus dans une liste d’autorisations ou de refus et déterminez s’il peut poursuivre le flux d’inscription.Validate whether the user is included in an allow or deny list, and control whether they can continue with the sign-up flow.

avant la création de l’utilisateurBefore creating the user

Un connecteur d’API à cette étape du processus d’inscription est appelé après la page de collection d’attributs, si elle est inclue.An API connector at this step in the sign-up process is invoked after the attribute collection page, if one is included. Cette étape est toujours appelée avant qu’un compte d’utilisateur ne soit créé dans Azure AD.This step is always invoked before a user account is created in Azure AD. Voici quelques exemples de scénarios que vous pouvez activer à cette étape au cours de l’inscription :The following are examples of scenarios you might enable at this point during sign-up:

  • Validez les données d’entrée utilisateur et demandez à un utilisateur de renvoyer des données.Validate user input data and ask a user to resubmit data.
  • Bloquer l’inscription utilisateur en fonction des données entrées par l’utilisateur.Block a user sign-up based on data entered by the user.
  • Exécuter une vérification d’identité.Perform identity verification.
  • Interrogez des systèmes externes pour obtenir des données existantes sur l’utilisateur afin de les retourner dans le jeton d’application ou de les stocker dans Azure AD.Query external systems for existing data about the user to return it in the application token or store it in Azure AD.

Étapes suivantesNext steps