Le script Get User permet d’implémenter la fonction exécutée pour déterminer l’état actuel d’existence d’un utilisateur. Nous recommandons de nommer cette fonction getUser.
Ce script est requis pour la migration automatique, et conditionnellement requis pour l’authentification héritée en fonction des opérations configurées pour la connexion.
Si la migration automatique est configurée pour la connexion et que le profil utilisateur n’a pas encore été créé, le script est exécuté chaque fois que les opérations suivantes se produisent :
- Modifier l’adresse courriel
- Inscription
- Réinitialisation du mot de passe
Si l’authentification héritée est configurée pour la connexion, le script est exécuté chaque fois que les opérations suivantes se produisent :
- Créer un utilisateur
- Modifier l’adresse courriel
- Modifier le mot de passe
- Réinitialisation du mot de passe
La fonction getUser devrait :
- Envoyer l’identifiant de l’utilisateur vers l’API de la base de données externe.
- Renvoyer les données de profil de l’utilisateur si l’utilisateur a été trouvé.
- Renvoyer une erreur s’il y a eu un problème pour déterminer si l’utilisateur existe ou non.
La fonction getUser accepte deux paramètres et renvoie une fonction callback :
| Paramètre | Type | Description |
|---|
email | String | L’adresse courriel de l’utilisateur. |
callback | Fonction | Utilisé pour transmettre des données d’erreur ou de profil par le pipeline. |
Exemple
Voici un exemple fictif en JavaScript de la manière dont vous pourriez implémenter la fonction getUser. Pour voir des exemples propres à un langage, veuillez consulter Exemples de scripts propres à une langue.
La fonction callback est utilisée pour transmettre les données du profil utilisateur ou les données d’erreur à travers le pipeline.
La fonction callback (rappel) accepte jusqu’à deux paramètres et renvoie une fonction :
| Paramètre | Type | Requis | Description |
|---|
error | Objet | Requis | Contient des données d’erreur. |
profile | Objet | Facultatif | Contient les données du profil de l’utilisateur. |
Renvoyer le profil utilisateur (utilisateur trouvé)
Les données de profil renvoyées par le script d’obtention d’un utilisateur doivent être cohérentes avec les données de profil renvoyées par le script de connexion.
Si l’utilisateur est trouvé, transmettez une valeur nul au paramètre error et transmettez les données de profil de l’utilisateur au paramètre profile dans la forme normalisée. Outre les champs standard, vous pouvez inclure les champs user_metadata, app_metadata et mfa_factors.
Aucun profil utilisateur renvoyé (utilisateur non trouvé)
Si l’utilisateur n’est pas trouvé, transmettez une valeur null au paramètre d’erreur et omettez le paramètre profile.
Si une erreur se produit, transmettez les données d’erreur au paramètre error avec les informations pertinentes sur ce qui a mal tourné. Pour plus d’informations, veuillez consulter Dépannage des bases de données personnalisées.
Exemples de scripts propres à une langue
Auth0 fournit des exemples de scripts à utiliser avec les langages/technologies ci-dessous :
Fournisseur d’appartenances ASP.NET (MVC3 – Fournisseurs universels)
Fournisseur d’appartenances ASP.NET (MVC4 – Appartenance simple)
Base de données SQL de Windows Azure