APIを使用して、Oktaメールアドレスバウンスリストからメールアドレスのブロックを解除する方法
Last Updated:
Overview
Oktaからユーザーにメールが送信されたとき、受信側のメールサーバーがそれを拒否することがあり、パスワードのリセットや新規アカウントの作成などのOktaからのメールをユーザーが受信できない場合があります。
この場合、メールは受信サーバーによってドロップされ、バウンスと見なされ、Okta System Logに以下のメッセージが表示されて失敗します。
[Email delivery FAILURE: dropped(メール配信エラー:ドロップ)]または[Email delivery FAILURE: Bounce(メール配信エラー:バウンス)]
Okta管理者は、メールアドレスバウンスAPIを使用して、バウンスされたメールアドレスのリストを制御できます。Oktaから送信されたメールアドレスがメールサービス(バウンスされたメールリスト)からブロックされた場合、管理者はこのAPIを使用して、メールサービスから削除するブロックされたメールアドレスのリストを作成できます。
注:
- このAPIは、無料体験版および開発者Orgでは使用できません。
- これらのアクションを実行するにはSuperAdmin権限が必要です。
- スパムレポートリストからユーザーを削除するプロセスは、Oktaサポートに伝わります。明確化のため、お客様はこれらがスパムレポートの一部であることを必ず示す必要があります。
Applies To
- メールアドレス
- API
Cause
この問題は、メール送信時に受信者のメールボックスがセットアップされていない、受信トレイがいっぱいである、アドレスが有効でない、またはその他の理由で受信トレイがOktaからのメールを受け付けていないために、メールプロバイダーがOktaからのメールを拒否する場合に発生する可能性があります。
Okta System Log内のメールエラーの追跡の詳細については、「メール到達率のトラブルシューティング」の記事を参照してください。
Solution
このビデオでは、Okta System Logでメールバウンスを特定し、Postmanでそれをクリアする方法について説明します。
-
APIトークンを使用してOktaテナントにAPI呼び出しを送信するための環境を準備します。この例では、Postmanを使用します。
-
OktaテナントのメールバウンスエンドポイントへのPOSTリクエストを作成します。例:https://<subdomain>.okta.com/api/v1/org/email/bounces/remove-list
-
バウンスリストからリクエストを削除するには、メールアドレスを使用してリクエスト本文に次のコードを入力します。
{ "emailAddresses": [ "name@company.com" ] }
これは、複数のメールアドレスをカンマで区切って行うこともできます。 - 次のヘッダーを追加して、構築されたクエリが正しく機能することを確認します。
- キー:Accept
- 値:
application/json
- 値:
- キー:Content-Type
- 値:
application/json
- 値:
- キー:Accept
- リクエストを送信した後、応答が成功すると、HTTP 200 OKステータスコードと、エラーがなかったことを示す次の出力が返されます。
メールに既存のバウンスがあったかどうかに関係なく、同じ成功応答が表示されます。既存のバウンスがあった場合は、2分ごとに実行される非同期ジョブによって削除されます。
Okta Organizationに属していない、または有効な形式ではないメールアドレスを使用してリクエストを送信すると、次のエラーを受信することがあります。
- 無効なメールアドレスです。提供されたメールアドレスは、RFC 3696に対する検証に失敗しました。
- このメールアドレスは、組織内のどのユーザーにも属していません。
バウンスされたメールを削除するAPIリクエストが作成されると(POST /org/email/bounces/remove-list)、次のSystem Logイベントsystem.email.bounce.removal イベントがトリガーされるようになりました。このリクエストは、メールのリストをサードパーティのメールサービスに送信して、バウンスリストからメールを削除します。このイベントは、APIリクエストが行われるとトリガーされます。このイベントは、メールがサードパーティのメールサービスによって実際にいつ削除されたかを示すものではありません。
このイベントタイプに関する追加情報は、Oktaイベントタイプカタログに記載されています。
