メールおよびSMSプロバイダーのカスタマイズ

Email Domain Authentication メールドメインを認証するには、API をご利用ください。 APIに関する詳細については、 「メールドメイン認証」 を参照してください。

1. メールアドレスのドメインを登録してください。 https://{tenanturl}/config/v1.0/email-domain-auth
   例

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth \
        --header 'accept: application/json' \
        --header 'content-type: application/json'

2. メールドメインのDNSレコードを取得してください。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
   例

   curl --request GET \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

3. メールドメインの状態を確認してください。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
   例

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
        --header 'accept: application/json'

4. カスタムメールドメインを変更または更新するには、まず通知から既存のカスタムメールドメインを削除し、その後、新しいドメインを登録する必要があります。

   メール認証ドメインを削除してください。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

   例

   curl --request DELETE \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

• IBM Verify外部SMSプロバイダーは、からのOTP通知リクエストを受信するために、 HTTP のPOST Webhookエンドポイントを公開する必要があります。
• エンドポイントは、リクエストを直ちにキューに入れ、 HTTP レスポンスを返す必要があります。

{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}

destinationPhoneNumber

受信者の電話番号（ E.164 形式）。

content

ユーザーに表示されるSMSメッセージの全文。

category

OTP

language

ロケールまたは言語コード（例：en-US）。

otp

ワンタイムパスワードの値。

correlation

OTPと認証フローを関連付けるためのID。通常、メッセージ内に記載される。

expiry

有効期間（分単位）。

202 受理

リクエストが正常にキューに登録されました。

400 Bad Request

ペイロード形式が無効です。

500 内部サーバー・エラー

プロバイダーが処理できません。

{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}

{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}