利用可否はAuth0のプランによって異なります
この機能を利用できるかどうかは、ログイン実装の内容と、Auth0のプランまたはカスタム契約の両方によって決まります。詳しくは、Pricingをご覧ください。
制限事項
- Auth0で送信できるユーザー招待はメール経由のみです。別の方法で招待を送りたい場合は、招待URLのみを生成することもできます。
- 招待されたユーザーは、招待の送信先メールアドレスを使ってログインするか、アカウントを作成する必要があります。
メンバーシップ招待フローをアプリケーションに統合する
URIを設定する
ルートの動作を指定する
invitation および organization パラメーターを受け取り、その後、両方のパラメーターを付けて Auth0 Authentication API の Authorization エンドポイントを呼び出す必要があります。
アプリケーション内で organization名 をサブドメインまたはパス変数として使用するマルチテナントのシナリオ (たとえば
acme.myapp.com) をサポートするため、ユーザーに送信される招待リンクには organization_name パラメーターも含まれます。このパラメーターを Authentication API の Authorization エンドポイントに送信する必要はありません。https://myapp.com/login に設定されている organization 対応のアプリケーションがある場合、エンドユーザーに送信されるメール招待内のリンクは次のようになります。https://myapp.com/login?invitation={invitation_ticket_id}&organization={organization_id}&organization_name={organization_name}
ユーザー招待フローをカスタマイズする
ユーザー招待フローをカスタマイズするには、カスタムドメインを使用する必要があります。Free プランでは 1 つのカスタムドメインを無料で利用でき、追加のカスタムドメインはすべての有料プランで利用できます。
ローカライズ
user_metadata パラメータを招待エンドポイントに送信できます。ユーザー招待フローをローカライズする際は、User Invitation メールテンプレートからこのパラメータにアクセスし、他の多言語メールテンプレートと同じロジックを使用できます。
招待されたユーザーが適切な言語で招待内容を表示するには、アプリケーションが ui_locales パラメータを送信するか、招待されたユーザーのブラウザーが適切な Accept-Language ヘッダーを送信する必要があります。詳しくは、メールテンプレートのカスタマイズ: 多言語メールテンプレートを参照してください。
メンバーシップ招待を送信する
ユーザーが招待を承諾すると、そのメールアドレスは確認済みとしてマークされます。ユーザーがフェデレーションログイン経由で招待を承諾する場合、アイデンティティプロバイダーは、招待の送信先と一致するメールアドレスを返す必要があります。メールアドレスの確認状態は、その後のログイン時にアイデンティティプロバイダーから返される値で上書きされることはありません。ユーザーが有効期限までに招待を承諾しない場合、その招待は期限切れとしてマークされ、最終的に Auth0 Dashboard から削除されます。