メール / パスワード認証

新しいユーザーアカウントのステータス

ユーザー アカウントは、「保留中」と「確認済み」の 2 つの状態のいずれかになります。

確認プロセスが開始されると、Atlas App Services はユーザー アカウントを作成し、ステータスをPending Confirmationに設定します。この状態では、ユーザーはログインできません。メールアドレスはユーザーアカウントに関連付けられているため、同じメールアドレスを再登録しようとすると失敗します。

アカウントが保留状態の場合、ユーザーはログインする前にアカウントを確認する必要があります。ユーザーがアカウントを確認すると、Atlas App Services はステータスを Confirmed と設定し、ユーザーはログインできるようになります。

ユーザーを自動的に確認した場合、アカウントが Confirmed のステータスで作成され、ユーザーは登録後すぐにログオンできます。

保留中のユーザー アカウントの一覧は、UI または App Services API を使用して表示できます。

確認メールの送信

この確認方法では、ユーザーは登録時にメールに返信する必要があります。メールには、確認 URL へのリンクが含まれています。ユーザーは 30 分以内にこのリンクにアクセスして、メールアドレスを管理していることを確認する必要があります。

App Services が確認メールを自動的に送信するようにするには、次の設定を構成します。

• Email Confirmation URL: すべての確認メールに含まれる URL のベース。App Services は、この URL にユニークな token と tokenId を追加します。これらは、すべての確認に対してユニークなリンクを作成するクエリ パラメーターとして機能します。ユーザーを確認するには、まずユーザー固有の URL からこれらのクエリパラメーターを抽出します。次に、 token と tokenId をクライアント SDK の confirmUser 関数に渡します。

  モバイル・アプリケーションは、アプリ内で直接メール確認を取り扱えます。これを行うには、ディープリンク を Android またはユニバーサルリンク iOS で設定します。

• Email Confirmation Subject: App Services が送信するメールの件名。この値はオプションです。省略した場合、App Services は代わりにデフォルトの件名を使用します。カスタム確認メールの件名には、最大 256 文字を含められます。

確認機能の実行

新しいユーザーが登録したときに Run a Confirmation Function が可能です。App Services は、確認トークン、トークン ID、およびユーザーのメールを、作成した関数に渡します。次に、関数はユーザーの確認に必要なロジックを実行し、次の結果オブジェクトのいずれかを返します。結果オブジェクトについては、以下で詳しく説明しています。

• { status: 'success' }

• { status: 'fail' }

• { status: 'pending' }

関数内で、ユーザーを確認するカスタム ロジックを定義します。たとえば、関数は次のようになります。

• 特定のドメインからカスタム確認メールを送信します。外部サービスを使用して、特定のテンプレートでこれらを送信します。

• MongoDB Atlas または外部 REST サービス内のコレクションからユーザー権限を読み取ります。

• SMS など、メール以外のサービスで確認メールを送信します。

カスタム確認関数シグネチャには 1 つのパラメーターがあります。これは、ユーザー データと確認トークンを含むオブジェクトです。これらのフィールドは次のとおりです。

カスタム ユーザー確認関数は、ステータス フィールドを持つオブジェクトを返します。次の表では、このフィールドの潜在的な値について説明しています。

以下は、ユーザー確認関数の例です。

1. 指定したメールが有効なメールであることを確認します。

2. 指定したメールで特定のサービスにアクセスできることを確認します。

3. ユーザーに SMS メッセージを送信します。

4. メッセージが正常に送信された場合、Atlas App Services に「保留中」ステータスの新しいアカウントを作成するように通知します。

exports = ({ token, tokenId, username }) => {
   // Validate the username
   const isValidEmail = myCustomValidatorService.validate(username);
   // Check if the user has access to this service
   const isPrivileged =
      myCustomAuthorizationService.hasAccess(username)
   // Send a message to the user so that they can confirm themselves
   const msgSendSuccessful = isValidEmail && isPrivileged
      && mySmsService.send(username, token, tokenId)
   if ( msgSendSuccessful ) {
      return { status: 'pending' };
   } else {
      return { status: 'fail' };
   }
}

カスタム関数が自動的にユーザーを確認しない限り、関数の実行後にユーザーは確認プロセスを完了するための手段を提供する必要があります。追加の確認手順が完了したら、SDK の Confirm User メソッドを呼び出して、Atlas App Services でのユーザー アカウントの作成を終了します。

ユーザーの自動確認

プロバイダーを Automatically Confirm Users に設定できます。このオプションを選択すると、App Servicesは、登録後すぐに新しいメール/パスワードユーザーを確認します。

パスワード リセット メールの送信

プロバイダーをSend a Password Reset Email.に構成できます。ユーザーがパスワードのリセットを要求すると、App Services はパスワードのリセット URL をユーザーのメール アドレスに送信します。ユーザーは 30 分以内にこの URL にアクセスする必要があります。

パスワード リセット メールを構成するときに、次の設定を構成できます。

• Password Reset URL: すべてのパスワード リセット メールに含まれる URL のベース。App Services は、この URL にユニークな token と tokenId を追加します。これらは、パスワードのリセットごとにユニークなリンクを作成するクエリ パラメーターとして機能します。ユーザーのパスワードをリセットするには、ユーザーのユニークな URL からこれらのクエリパラメーターを抽出します。トークンと tokenId をクライアント SDK の resetPassword 関数に渡します。

• Reset Password Email Subject: App Services が送信するメールの件名。この値はオプションです。省略すると、App Servicesはデフォルトの件名を代わりに使用します。カスタム パスワード リセットの件名には最大 256 文字を含められます。

モバイル アプリケーションでは、アプリ内で直接パスワードのリセットを取り扱えます。Android のディープリンクまたは iOS の ユニバーサル リンクを設定します。

パスワードリセット機能の実行

プロバイダーを Run a Password Reset Function に設定できます。SDK で callResetPasswordFunction() を実行するときに App Services が実行する関数を定義します。App Services は、ユーザーのメール、希望する新しいパスワード、確認トークン、トークン ID を、作成した関数に渡します。次に、関数はパスワードをリセットする前にユーザーの身元を確認するために必要なロジックを実行します。

App Services はユーザーのパスワードをすぐにリセットできます。または、クライアント・アプリケーションからの追加確認を要求することもできます。

App Services 関数は、 status キーを含むオブジェクトを返す必要があります。キーは、以下のいずれかの値を持つ文字列にマップされます。これらの値については、以下で詳しく説明しています。

• { status: 'success' }

• { status: 'fail' }

• { status: 'pending' }

カスタム パスワード リセット機能を使用して、独自のパスワード リセット フローを定義できます。

• 外部サービスを用いて、特定のテンプレートを使用して特定のドメインからカスタム パスワード リセット メールを送信します。

• MongoDB Atlas コレクションとのインターフェースを使用して、パスワードリセットの「クールダウン期間」を実装します。これにより、特定の時間範囲に 1 つのアカウントでパスワード リセットの試行回数が増えるのを食い止められます。

• メール以外のサービスを通じてカスタム パスワード リセット メッセージを送信します。

カスタム パスワード リセット関数のシグネチャーは可変長です。つまり、任意の数のパラメーターを受け入れます。最初のものは常に、ユーザー データと確認トークンを含むオブジェクトです。次のパラメーターはすべてカスタムパラメーターです。これらは引数コレクションとしてクライアント SDK に渡されます。たとえば、Client SDK は次のように呼び出します。

callResetPasswordFunction("myUsername", "newPassword", ["Security Question Answer 1", "Security Question Answer 2", "securityCode:0510"])

パスワード リセット機能のカスタマイズされた署名は次のようになります。

resetFunc({username, password, token, tokenId, currentPasswordValid}, securityAnswer1, securityAnswer2, securitySMSCode)

カスタム パスワード リセット関数では、最初のパラメーターとしてオブジェクトを渡す必要があります。以下の表は、このオブジェクトのフィールドを説明したものです。

カスタム パスワード リセット関数は、status フィールドを含むオブジェクトを返す必要があります。この status フィールドの値は、次のいずれかになります。

カスタム パスワード リセット機能には、次の例のような要素が含まれる場合があります。

exports = ({ token, tokenId, username, password, currentPasswordValid }) => {
   // check if the username corresponds to a real user
   const isUser = myCustomValidator.validate(username);
   // check if the user is attempting to reset their password to their current password
   if (currentPasswordValid) {
     myCustomNotifier.sendMessage(username, "Cannot reset password to current password.");
     return { status: 'fail' };
   }
   // check if the user has requested a password reset too often recently
   const isNotCoolingDown = myCustomCooldownService.canReset(username, 'myCustomService')
   // send a message to the user in some way so that the user can confirm themselves
   const msgSendSuccessful = isUser && isNotCoolingDown && myCustomMsgr.send(username, token, tokenId)
   if ( msgSendSuccessful ) {
      return { status: 'pending' };
   } else {
      return { status: 'fail' };
   }
}