Personnalisation des fournisseurs de services de messagerie électronique et de SMS

Vous pouvez personnaliser l'expéditeur des e-mails et le fournisseur de SMS pour les IBM® Verify messages de notification.

Avant de commencer

Si vous souhaitez intégrer votre propre fournisseur de SMS pour les notifications OTP d' IBM Verify, vous devez configurer un point de terminaison webhook externe capable d'accepter les requêtes POST provenant de IBM Verify. Si vous souhaitez également personnaliser l'adresse de l'expéditeur afin que les notifications semblent provenir de votre propre domaine, vous devez faire authentifier votre domaine de messagerie.

Authentification du domaine de messagerie

Pour authentifier votre domaine de messagerie, utilisez les Email Domain Authentication API. Pour plus d'informations sur les API, consultez la section « Authentification des domaines de messagerie ».

  1. Enregistrez votre domaine de messagerie. https://{tenanturl}/config/v1.0/email-domain-auth
    Exemple
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth \
         --header 'accept: application/json' \
         --header 'content-type: application/json'
  2. Récupérez les enregistrements DNS de votre domaine de messagerie. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
    Exemple
    curl --request GET \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
  3. Vérifiez le statut de votre domaine de messagerie. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
    Exemple
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
         --header 'accept: application/json'
  4. Pour modifier ou mettre à jour votre domaine de messagerie personnalisé, vous devez d'abord supprimer le domaine existant dans les paramètres de notification, puis enregistrer le nouveau.

    Supprimez votre domaine d'authentification de messagerie. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

    Exemple
    curl --request DELETE \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
Conditions requises pour la configuration d'un webhook externe
  • Le fournisseur de SMS externe doit mettre à disposition un point de terminaison webhook POST de type HTTP afin de recevoir les demandes de notification d'OTP provenant de IBM Verify.
  • Le point de terminaison doit immédiatement mettre les requêtes en file d'attente et renvoyer une réponse « HTTP ».
Exemple de contenu de requête JSON
{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}
Descriptions au niveau des champs
destinationPhoneNumber
Le numéro de téléphone du destinataire au format « E.164 ».
content
Le texte complet du SMS tel qu'il s'affiche à l'écran.
category
mot de passe à utilisation unique
language
Le code de langue ou de paramètres régionaux, par exemple en-US.
otp
La valeur du code d'accès à usage unique.
correlation
L'identifiant permettant d'associer l'OTP à un processus de vérification; il figure généralement dans le message.
expiry
La durée de validité en minutes.
Exigences relatives à la réponse du webhook
202 Accepté
La demande a été mise en file d'attente avec succès.
400 Demande incorrecte
Format de la charge utile non valide.
500 Erreur de serveur interne
Le fournisseur n'a pas pu traiter la demande.
Exemple de réponse indiquant que l'opération a réussi
{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}
Exemple de réponse en cas d'échec
{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}

A propos de cette tâche

IBM est le service de messagerie électronique et le fournisseur de SMS par défaut pour Verify.

Procédure

  1. Accédez à Configuration générale > Communication, puis sélectionnez l'onglet Expéditeurs.
  2. Pour modifier l'expéditeur de l'e-mail, cliquez sur crayon l'icône située sur la vignette « E-mail ».
    1. Modifiez les valeurs par défaut des options de messagerie suivantes.
      Tableau 1.

      Le tableau présente les caractéristiques des notifications par e-mail.

      Attribut Descriptif
      A partir de l'adresse de l'émetteur Changez la valeur de cette zone pour indiquer l'adresse électronique de l'émetteur de la notification.
      A partir du nom de messagerie électronique Changez la valeur de cette zone pour indiquer la personne ou l'organisation qui envoie la notification, par exemple, votre société.
    2. Facultatif : cochez la case « Utiliser un serveur de messagerie SMTP personnalisé ».
      Pour votre serveur SMTP personnalisé, indiquez les informations suivantes :
      • Hôte SMTP
      • Port 
      • Nom d'utilisateur
      • Mot de passe
      • Sélectionnez le protocole de connexion, TLS ou SSL.
    3. Cliquez sur Enregistrer.
  3. Si votre locataire utilise les services SMS d' IBM et que vous souhaitez modifier l'identifiant de l'expéditeur des SMS, cliquez sur crayon l'icône située sur la vignette du fournisseur de SMS.
    Vous pouvez modifier cet attribut pour l'adapter à votre entreprise ou à votre organisation.
    1. Modifiez la valeur par défaut de l'option suivante.
      Tableau 2.

      Le tableau présente les paramètres des notifications par SMS.

      Attribut Descriptif
      ID d'émetteur alphanumérique Changez la valeur de cette zone pour indiquer l'identificateur alphanumérique (A-Z, a-z, 0-9) qui identifie l'émetteur du message. La valeur doit commencer par un caractère alphabétique, ne peut pas comporter d'espace ni de caractère spécial, et ne doit pas contenir plus de 11 caractères.
      Remarque : Verify ne prend pas en charge l'envoi de SMS.
    2. Cliquez sur « Enregistrer les modifications ».
  4. Si votre locataire n'utilise pas les services SMS d' IBM, et que vous souhaitez faire appel à un fournisseur de SMS externe, cliquez sur « Ajouter un fournisseur de SMS externe » dans la vignette « Fournisseur de SMS ».
    1. Indiquez le nom du fournisseur de services SMS.
      Vous pouvez également indiquer un propriétaire et des informations de contact par courrier électronique.
    2. Indiquez l' URL de la requête.
      L' URL e le point de terminaison du fournisseur de SMS externe que le service de notification appelle pour envoyer un SMS.
    3. Sélectionnez le type d'authentification.
      Basique
      Indiquez le nom d'utilisateur et le mot de passe.
      En-tête
      Indiquez le nom d'en-tête et le secret d'authentification. Si le secret est sensible à la casse, cochez la case Sensible.
      Aucune
      Aucune information d'authentification n'est requise.
      OAuth
      Indiquez le point de terminaison du jeton. Indiquez si le secret client est de type POST ou Basic. Saisissez l'identifiant client et la clé secrète.
      Remarque : le message du client indique que le secret est stocké sous forme d'attribut. Client basic signifie que le secret est stocké dans l'en-tête.
      Jeton Web JSON (JWT)
      Indiquez la valeur de l'en-tête « HTTP », la sous-réclamation, la durée de validité maximale du JWT et l'algorithme de signature. Si vous le souhaitez, vous pouvez également définir un préfixe pour les valeurs d'en-tête JWT, des clés d'en-tête JWT et des noms de revendications.
      Mutual TLS ( mTLS )
      Indiquez le nom du certificat MTLS.
    1. Cliquez sur Enregistrer.
      Le fournisseur de SMS est créé, mais désactivé par défaut.
    2. Vérifiez si votre locataire est connecté à votre fournisseur de SMS, puis cliquez sur « Tester la connexion ».
      Vous pouvez envoyer un message test à votre opérateur SMS pour vérifier la connexion.
    3. Une fois le test de connexion réussi et lorsque vous êtes prêt à utiliser votre fournisseur de SMS externe, cliquez sur le bouton de configuration pour l'activer.
    4. Facultatif : pour vérifier l'état de votre fournisseur de SMS, cliquez sur « Afficher les statistiques d'état ».
      La section « État de santé » fournit un résumé des connexions, ainsi que l'historique et les statistiques de connexion pour l' URL du fournisseur de SMS