Anpassen von E-Mail- und SMS-Anbietern

Sie können den E-Mail-Absender und den SMS-Anbieter für die IBM® Verify Benachrichtigungen anpassen.

Vorbereitende Schritte

Wenn Sie Ihren eigenen SMS-Anbieter für OTP-Benachrichtigungen unter IBM Verify integrieren möchten, müssen Sie einen externen Webhook-Endpunkt konfigurieren, der POST-Anfragen von IBM Verify akzeptiert. Wenn Sie auch die Absenderadresse der E-Mails so anpassen möchten, dass die Benachrichtigungen scheinbar von Ihrer eigenen Domain stammen, müssen Sie Ihre E-Mail-Domain authentifizieren lassen.

E-Mail-Domänenauthentifizierung

Um Ihre E-Mail-Domain zu authentifizieren, nutzen Sie die Email Domain Authentication APIs. Weitere Informationen zu den APIs finden Sie unter „E-Mail-Domänenauthentifizierung “.

  1. Registrieren Sie Ihre E-Mail-Domain. https://{tenanturl}/config/v1.0/email-domain-auth
    Beispiel
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth \
         --header 'accept: application/json' \
         --header 'content-type: application/json'
  2. Rufen Sie die DNS-Einträge für Ihre E-Mail-Domain ab. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
    Beispiel
    curl --request GET \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
  3. Überprüfen Sie den Status Ihrer E-Mail-Domain. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
    Beispiel
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
         --header 'accept: application/json'
  4. Um Ihre benutzerdefinierte E-Mail-Domain zu ändern oder zu aktualisieren, müssen Sie die bestehende benutzerdefinierte E-Mail-Domain aus den Benachrichtigungen löschen und anschließend die neue registrieren.

    Löschen Sie Ihre E-Mail-Authentifizierungsdomäne. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

    Beispiel
    curl --request DELETE \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
Voraussetzungen für die Einrichtung eines externen Webhooks
  • IBM VerifyDer externe SMS-Anbieter muss einen POST-Webhook-Endpunkt unter HTTP bereitstellen, um OTP-Benachrichtigungsanfragen von [Name] zu empfangen.
  • Der Endpunkt muss Anfragen unverzüglich in die Warteschlange stellen und eine „ HTTP “-Antwort zurückgeben.
Beispiel für den Payload einer JSON-Anfrage
{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}
Beschreibungen auf Feldebene
destinationPhoneNumber
Die Telefonnummer des Empfängers im Format „ E.164 “.
content
Der vollständige SMS-Text, der dem Benutzer angezeigt wird.
category
OTP
language
Der Ländercode oder Sprachcode, zum Beispiel en-US.
otp
Der Wert des Einmal-Passworts.
correlation
Die ID zur Verknüpfung des OTP mit einem Verifizierungsablauf; wird in der Regel in der Nachricht angezeigt.
expiry
Die Gültigkeitsdauer in Minuten.
Anforderungen an die Webhook-Antwort
202 Angenommen
Die Anfrage wurde erfolgreich in die Warteschlange gestellt.
400 Bad Request (Falsche Anforderung)
Ungültiges Payload-Format.
500 Interner Serverfehler
Der Anbieter kann die Anfrage nicht bearbeiten.
Beispiel für eine erfolgreiche Antwort
{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}
Beispiel für eine Fehlermeldung
{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}

Informationen zu dieser Task

IBM ist der Standard-E-Mail-Absender und SMS-Anbieter für Verify.

Vorgehensweise

  1. Navigieren Sie zu „Globale Konfiguration“ > „Kommunikation“ und wählen Sie die Registerkarte „Absender“ aus.
  2. Um den E-Mail-Absender zu ändern, klicken Sie auf das Stift Symbol auf der E-Mail -Kachel.
    1. Ändern Sie die Standardwerte für die folgenden E-Mail-Optionen.
      Tabelle 1.

      Die Tabelle beschreibt die Attribute für E-Mail-Benachrichtigungen.

      Attribut Beschreibung
      Adresse des Senders Ändern Sie dieses Feld, um die E-Mail-Adresse widerzuspiegeln, die als Sender der Benachrichtigung aufgelistet werden soll.
      Name des E-Mail-Senders Ändern Sie dieses Feld, um die Person oder Organisation widerzuspiegeln, die die Benachrichtigung sendet, beispielsweise Ihre Firma.
    2. Optional: Aktivieren Sie das Kontrollkästchen „Benutzerdefinierten SMTP-E-Mail-Server verwenden “.
      Geben Sie für Ihren angepassten SMTP-Server die folgenden Informationen an:
      • SMTP-Host
      • Port
      • Benutzername
      • Kennwort
      • Wählen Sie das Verbindungsprotokoll, entweder TLS oder SSL, aus.
    3. Klicken Sie auf „Speichern “.
  3. Wenn Ihr Mieter die SMS-Dienste von „ IBM “ nutzt und Sie die Absender-ID für SMS ändern möchten, klicken Sie auf das Stift Symbol auf der Kachel des SMS-Anbieters.
    Sie können das Attribut an Ihr Unternehmen oder Ihre Organisation anpassen.
    1. Ändern Sie den Standardwert für die folgende Option.
      Tabelle 2.

      Die Tabelle beschreibt die Attribute für SMS-Benachrichtigungen.

      Attribut Beschreibung
      Alphanumerische Absender-ID Ändern Sie dieses Feld, um die alphanumerische ID (A-Z, a-z, 0-9) widerzuspiegeln, die den Sender der Nachricht angibt. Der Wert muss mit einem alphabetischen Zeichen beginnen, darf keine Leerzeichen oder Sonderzeichen umfassen und hat eine maximale Länge von 11 Zeichen.
      Hinweis: Verify unterstützt keine SMS-Nachrichten.
    2. Klicken Sie auf „Änderungen speichern “.
  4. Wenn Ihr Mieter die SMS-Dienste von „ IBM “ nicht nutzt und Sie einen externen SMS-Anbieter verwenden möchten, klicken Sie auf der Kachel „SMS-Anbieter“ auf „Externen SMS-Anbieter hinzufügen “.
    1. Geben Sie einen Namen für den SMS-Anbieter an.
      Sie können auch einen Eigner und E-Mail-Kontaktinformationen angeben.
    2. Geben Sie die Anforderungs- URL an.
      Die „ URL “ verweist auf den Endpunkt des externen SMS-Anbieters, den der Benachrichtigungsdienst zum Versenden einer SMS aufruft.
    3. Wählen Sie den Typ der Authentifizierung aus.
      Basis
      Geben Sie den Benutzernamen und das Kennwort an.
      Header
      Geben Sie den Headernamen und den geheimen Authentifizierungsschlüssel an. Wenn beim geheimen Schlüssel die Groß-/Kleinschreibung beachtet werden muss, wählen Sie das Kontrollkästchen Beachten aus.
      Ohne
      Es sind keine Authentifizierungsinformationen erforderlich.
      OAuth
      Geben Sie den Token-Endpunkt an. Wählen Sie aus, ob es sich bei dem Client-Secret um „Post“ oder „Basic“ handelt. Geben Sie die Client-ID und den geheimen Schlüssel ein.
      Hinweis: Aus dem Beitrag des Kunden geht hervor, dass das Geheimnis als Attribut gespeichert ist. "Client basic" gibt an, dass der geheime Schlüssel im Header gespeichert wird.
      JSON Web Token (JWT)
      Geben Sie den Wert des „ HTTP “-Headers, den „Sub“-Claim, die maximale Gültigkeitsdauer des JWT und den Signaturalgorithmus an. Wenn Sie möchten, können Sie auch ein Präfix für JWT-Header-Werte, JWT-Header-Schlüssel und Claim-Namen angeben.
      Gegenseitiges TLS ( mTLS )
      Geben Sie die Bezeichnung des MTLS-Zertifikats an.
    1. Klicken Sie auf „Speichern “.
      Der SMS-Anbieter wurde angelegt, ist jedoch standardmäßig deaktiviert.
    2. Prüfen Sie, ob Ihr Mandant mit Ihrem SMS-Anbieter verbunden ist, und klicken Sie auf „Verbindung testen “.
      Sie können eine Testnachricht an Ihren SMS-Anbieter senden, um die Verbindung zu testen.
    3. Nachdem der Verbindungstest erfolgreich verlaufen ist und Sie bereit sind, Ihren externen SMS-Anbieter zu nutzen, klicken Sie auf den Kon figurationsschalter, um ihn zu aktivieren.
    4. Optional: Um den Status Ihres SMS-Anbieters zu überprüfen, klicken Sie auf „Statusdaten anzeigen “.
      Der Status bietet eine Zusammenfassung der Verbindung sowie einen Verbindungsverlauf und Statistiken für die SMS-Anbieter-ID ( URL ) des SMS-Anbieters