ルールのユーザーオブジェクトプロパティ

userオブジェクトはIDプロバイダーから返され、ログイン済みユーザーについての情報が保管されます。ユーザーの認証時、ルールの実行前に生成されます。ユーザー認証ではイベントに順序があるため、ルール内からユーザープロファイルに対して実行された変更内容は、その同じルール内からユーザーオブジェクトに対して変更内容を保存すると、現在のユーザーオブジェクトでのみ使用可能になります。

認証トランザクションフローの詳細については、「ルールを作成する」にある「ルールの仕組み」セクションをお読みください。

プロパティ

以下のプロパティはuserオブジェクトで使用することができます。

プロパティ データタイプ 説明
user.app_metadata オブジェクト サポートプラン、セキュリティロール、アクセス制御グループなどのユーザーアクセスに影響するユーザーについての情報を保存するカスタムフィールドです。デフォルトでは、`undefined`です。詳細はメタデータをご覧ください。
user.created_at 日時 ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。
user.email テキスト （一意）ユーザーのメールアドレス。
user.email_verified ブール値 ユーザーがメールアドレスを確認済みかどうかを示します。
user.family_name テキスト ユーザーの姓。
user.given_name テキスト ユーザーの名。
user.identities 配列（オブジェクト） ユーザーを最初に認証したIDプロバイダーから取得された情報を格納します。ユーザーはプロファイルを複数のIDプロバイダーにリンクすることもできますが、その場合にはそれらのアイデンティティーもこの配列に含まれます。個別のIDプロバイダーオブジェクトのコンテンツはプロバイダーによって異なりますが、一般的には次のものを含みます：
  • connection （テキスト）：ユーザーの認証に使用されるAuth0接続の名前。
  • isSocial（ブール値）：接続がソーシャルのものか示します。
  • provider（テキスト）：Facebook、Google、SAML、または独自のプロバイダーといったユーザーを認証するエンティティの名前。
  • user_id （テキスト）：この接続/プロバイダーのユーザーの一意ID。最初のuser_idリンクはユーザーの主要の一意IDになります。
  • profileData（オブジェクト）：接続に関連づけられたユーザー情報。プロファイルがリンクされると、そこにはセカンダリアカウントの関連するユーザー情報が入力されます。
場合によっては、プロバイダーに使用されるAPIアクセストークンを含むものもあります。
user.last_password_reset 日時 ユーザーパスワードがリセット/変更された最終日時を示すタイムスタンプ。ユーザーの作成時に、このフィールドは存在しません。このフィールドは、データベース接続でのみ利用できます。
user.multifactor 配列（テキスト） ユーザーが登録された多要素認証（MFA）プロバイダーのリスト。この配列は、ユーザーがMFAに登録されたときと管理者がユーザーのMFA登録をリセットするときに更新されます。
user.name テキスト ユーザーの氏名。
user.nickname テキスト ユーザーのニックネーム。
user.permissions テキスト 認可拡張機能を使用した場合にユーザーのIDトークンに割り当てられる許可。
user.phone_number テキスト ユーザーの電話番号。SMS接続のあるユーザーに対してのみ有効です。
user.phone_verified ブール値 ユーザーが電話番号を確認済みかどうかを示します。SMS接続のあるユーザーに対してのみ有効です。
user.picture テキスト ユーザーのプロファイル写真 を指すURL。
user.updated_at 日時 ユーザーのプロファイルが最後に更新/変更された日時を示すタイムスタンプ。last_loginの変更は更新と見なされます。そのため、ほとんどの場合、updated_atはlast_loginに一致します。
user.user_id テキスト （一意）ユーザーの一意のプライマリID。
user.user_metadata オブジェクト 勤務先住所、自宅住所、ユーザーの設定など、ユーザーのアクセスに影響を与えないユーザーの情報を保存するカスタムフィールド。詳細はメタデータをご覧ください。
user.username テキスト （一意）ユーザーのユーザー名。