Configurer un fournisseur téléphonique personnalisé

Vous pouvez configurer un fournisseur téléphonique personnalisé pour les messages SMS en utilisant un numéro de téléphone comme identifiant d’utilisateur. Un fournisseur téléphonique personnalisé utilise Actions pour acheminer les messages SMS vers le fournisseur téléphonique de votre choix lors de la vérification des numéros de téléphone et de la réinitialisation des mots de passe. Vous souhaiterez peut-être configurer un fournisseur téléphonique personnalisé pour les cas d’utilisation suivants :

Utiliser différents fournisseurs téléphoniques selon le contexte de l’application, notamment dans différentes régions géographiques où le coût des messages peut varier considérablement d’un fournisseur à l’autre.
Utiliser différents fournisseurs téléphoniques selon le contexte de l’organisation, lorsque certains clients B2B exigent des fournisseurs précis.

Vous pouvez configurer un fournisseur téléphonique personnalisé dans l’ ou avec la .

Configurer un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard ou avec la Management API

Pour configurer un fournisseur téléphonique personnalisé, vous devez utiliser le déclencheur d’action custom-phone-provider, qui n’est pas disponible dans l’éditeur d’Actions. Pour en savoir plus, consultez Exemple d’Action custom-phone-provider.

Auth0 Dashboard
Management API

Ajouter un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Pour configurer un nouveau fournisseur téléphonique personnalisé dans l’Auth0 Dashboard :

Accédez à Branding > Phone Provider. Vous arriverez à la page Phone Message Provider. Par défaut, le fournisseur de téléphone Twilio est sélectionné.
Sélectionnez l’option de fournisseur de téléphone Custom dans la section Phone Provider.
Sélectionnez la méthode de livraison :
1. Text : le code de vérification sera envoyé à vos utilisateurs par SMS.
2. Voice : le code de vérification sera envoyé à vos utilisateurs par message vocal.
Sous Provider Configuration, saisissez votre code Actions pour configurer un fournisseur téléphonique personnalisé :
1. Consultez la documentation de votre fournisseur pour comprendre comment envoyer des messages à son API.
2. Ajoutez les secrets requis pour vous authentifier auprès de l’API.
3. (Facultatif) Vous pouvez modifier l’Action dans l’interface complète d’éditeur d’Actions en cliquant sur le bouton Edit in Expanded Editor. Après avoir modifié votre action dans éditeur d’Actions, cliquez sur Save puis sur Deploy dans cette interface. Cliquez sur le lien Back to Phone Provider en haut de la page d’éditeur d’Actions pour revenir à la page Phone Message Provider. Vous devrez sélectionner de nouveau l’option de fournisseur de téléphone Custom dans la section Phone Provider.
Cliquez sur le bouton Save au bas de la page.

Lorsque vous cliquez sur Save, l’Action est automatiquement enregistrée et déployée. Pour tester la configuration du fournisseur téléphonique personnalisé avant de l’utiliser dans un environnement de production, cliquez sur Send Test Message.

Vous ne pouvez pas cliquer sur Send Test Message pour tester votre fournisseur téléphonique personnalisé tant que sa configuration n’a pas été enregistrée.

Modifier un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Pour modifier un fournisseur téléphonique personnalisé existant dans l’Auth0 Dashboard :

Accédez à Branding > Phone Provider. Vous arriverez à la page Phone Message Provider.
Modifiez le code de l’Action sur la page Phone Message Provider au besoin.
1. (Facultatif) Vous pouvez modifier l’Action dans l’interface complète d’éditeur d’Actions en cliquant sur le bouton Edit in Expanded Editor. Après avoir modifié votre Action dans éditeur d’Actions, cliquez sur Save puis sur Deploy dans cette interface. Cliquez ensuite sur le lien Back to Phone Provider en haut de la page d’éditeur d’Actions.
Cliquez sur le bouton Save au bas de la page.

Ajouter un fournisseur téléphonique personnalisé avec la Management API

Vous pouvez aussi configurer un fournisseur téléphonique personnalisé à l’aide de la Management API. Il s’agit d’un processus en plusieurs étapes :

Créez une Action et définissez supported_triggers.id sur custom-phone-provider.
1. Consultez la documentation de votre fournisseur pour comprendre comment envoyer des messages à son API.
2. Ajoutez les secrets requis pour vous authentifier auprès de l’API.
Déployez l’action.
Définissez le phone provider sur custom.

L’Action que vous créez avec le trigger custom-phone-provider n’apparaîtra pas dans la bibliothèque Actions.

Si aucune Action n’est déployée et que vous essayez de configurer un fournisseur custom, Auth0 renverra une erreur avec \"errorCode\":\"custom_email_provider_deployed_action_not_found\".

Modifier un fournisseur téléphonique personnalisé avec la Management API

Vous pouvez aussi modifier un fournisseur téléphonique personnalisé à l’aide de la Management API.

(Facultatif) Si vous ne connaissez pas l’Action ID précis, vous pouvez obtenir la liste des actions au moyen de la Management API. La réponse comprendra un objet Actions. L’Action utilisée pour le fournisseur téléphonique personnalisé peut être identifiée par supported_triggers.id, qui doit être défini sur custom-phone-provider.
Mettez à jour l’Action au besoin.
Déployez l’Action.

Un exemple de fournisseur téléphonique personnalisé que vous pouvez configurer est Twilio Verify. Pour en savoir plus, consultez Configurer un fournisseur téléphonique personnalisé avec Twilio Verify.

Exemple d’Action custom-phone-provider

Le déclencheur custom-phone-provider est différent du déclencheur send-phone-message, qui ne doit pas servir à configurer un fournisseur téléphonique personnalisé. Pour en savoir plus, consultez ce qui suit :

L’exemple de code suivant montre une Action custom-phone-provider qui offre la fonctionnalité d’une Action send-phone-message :

/**
* Gestionnaire à exécuter lors de l’envoi d’une notification téléphonique*
* @param {Event} event - Renseignements sur l’utilisateur et le contexte dans lequel il se connecte.
* @param {CustomPhoneProviderAPI} api - Méthodes et utilitaires permettant de modifier le comportement de l’envoi d’une notification téléphonique.
*/
exports.onExecuteCustomPhoneProvider = async (event, api) => {

  if (event.notification.message_type.startsWith('otp')) {
    const body = {
      from: event.notification.from,
      action: event.notification.message_type === 'otp_verify' ? 'second-factor-authenticator' : 'enrollment',
      language: event.notification.locale,
      recipient: event.notification.recipient,
      message_type: event.notification.delivery_method,
      text: event.notification.as_text,
      code: event.notification.code,
    };

    const response = await fetch(event.secret.SERVICE_URL, {
      method: 'POST',
      headers: {
        authorization: `Bearer ${event.secrets.TOKEN}`,
      },
      body: JSON.stringify(body),
    });

    console.log(response);
  }

  return;
};

Personnalisation de la marque

Personnalisation du code

Personnalisation tierce

Configurer un fournisseur téléphonique personnalisé

Configurer un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard ou avec la Management API

Ajouter un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Modifier un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Ajouter un fournisseur téléphonique personnalisé avec la Management API

Modifier un fournisseur téléphonique personnalisé avec la Management API

Exemple d’Action custom-phone-provider

​Configurer un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard ou avec la Management API

​Ajouter un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

​Modifier un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

​Ajouter un fournisseur téléphonique personnalisé avec la Management API

​Modifier un fournisseur téléphonique personnalisé avec la Management API

​Exemple d’Action custom-phone-provider

Configurer un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard ou avec la Management API

Ajouter un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Modifier un fournisseur téléphonique personnalisé dans l’Auth0 Dashboard

Ajouter un fournisseur téléphonique personnalisé avec la Management API

Modifier un fournisseur téléphonique personnalisé avec la Management API

Exemple d’Action custom-phone-provider