ユーザープロファイルの構造

Auth0ユーザープロファイルで利用可能な属性を一覧表示します

Auth0の正規化されたユーザープロファイルは、いくつかの異なるコンポーネントで構成されています。

• 詳細: 中核となるユーザープロファイルオブジェクトで、名前、メールアドレス、ユーザーの最新ログイン日時などの基本情報が、あらかじめ定義された属性に格納されています。このオブジェクトには、ユーザーの接続元の接続から取得された情報が含まれる場合もあります。ユーザー属性の大半はルート属性 (user オブジェクトの最上位、つまりルートレベルに格納される属性) であり、その一部は編集可能です。
• メタデータ: カスタマイズ可能な属性に追加のユーザー情報を格納するための補助的な保存領域として機能する、2つのサブオブジェクトです: user_metadata と app_metadata。app_metadata と user_metadata の使い分けを含む詳細については、Understand How Metadata Works in User Profiles を参照してください。

​

ユーザープロファイル属性

以下の属性はユーザープロファイルで使用できます。多くはルート属性 (user オブジェクトの最上位、つまりルートレベルに格納される属性) であり、以下に記載するとおり、一部は更新、インポート、エクスポートが可能です。

プライバシー上の理由で Auth0 に保存すべきでないユーザーフィールドがある場合は、Auth0 のデータベースに保持させたくない属性を DenyList に追加できます。詳しくは、Deny List にユーザー属性を追加するをご覧ください。

デフォルトでは、Auth0 以外のアイデンティティプロバイダー (Google、Facebook、X など) から提供されるユーザープロファイル属性は、ユーザーがログインするたびにアイデンティティプロバイダーから更新されるため、直接編集できません。アイデンティティプロバイダー由来の属性の詳細については、ユーザープロファイル更新用にアイデンティティプロバイダー接続を設定するをご覧ください。

正規化されたユーザープロファイルの name、nickname、given_name、family_name、または picture のルート属性を編集できるようにするには、Auth0 との接続同期を設定し、ユーザー属性がアイデンティティプロバイダーから更新されるのはユーザープロファイル作成時のみになるようにする必要があります。そうすると、これらのルート属性を個別に、または一括インポートによって編集できるようになります

名前	タイプ	説明	検索可能?	更新可能?	インポート可能?	インポート時にアップサート可能?	エクスポート可能?
app_metadata	オブジェクト	サポートプラン、セキュリティロール (Authorization Core 機能セットを使用していない場合) 、アクセス制御グループなど、ユーザーのアクセスに影響する情報を保存するカスタムフィールドです。詳しくは、メタデータの概要をご覧ください。	Y	Y	Y	Y	Y
blocked	真偽値	ユーザーがブロックされているかどうかを示します。インポートすると、Auth0 への移行時にもユーザーのブロック状態を維持できます。	Y	はい	はい	いいえ	はい
blocked_for	配列 (オブジェクト)	ブルートフォース攻撃の疑いでブロックされたIPアドレス。	N	N	N	N	N
created_at	日時	ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。	Y	いいえ	いいえ	いいえ	はい
email	文字列	(一意) ユーザーのメールアドレス。	Y	Y	Y	N	Y
email_verified	真偽値	ユーザーがメールアドレスを確認済みであるかどうかを示します。	Y	Y	Y	Y	Y
family_name	文字列	ユーザーの姓。	Y	Y	Y	Y	Y
given_name	テキスト	ユーザーの名。	Y	Y	Y	Y	Y
guardian_authenticators	配列 (オブジェクト)	ユーザーが設定した Guardian のバックアップ認証方法 (SMS やリカバリーコードなど) に関する詳細情報。	N	N	N	N	N
identities	配列 (オブジェクト)	ユーザーが最初に認証したアイデンティティプロバイダーから取得された情報が含まれます。ユーザーは自分のプロファイルを複数のアイデンティティプロバイダーにリンクすることもできます。その場合、それらのアイデンティティもこの配列に表示されます。個々のアイデンティティプロバイダーのオブジェクトの内容はプロバイダーによって異なりますが、通常は次のものが含まれます。 connection (テキスト): ユーザーの認証に使用されるAuth0接続の名前。 isSocial (ブール値): その接続がソーシャル接続かどうかを示します。 provider (テキスト): Facebook、Google、SAML、または独自のプロバイダーなど、ユーザーを認証するエンティティの名前。 user_id (テキスト): この接続/プロバイダーにおけるユーザーの一意の識別子。 profileData (オブジェクト): 接続に関連付けられたユーザー情報。プロファイルがリンクされている場合は、セカンダリアカウントに関連付けられたユーザー情報が格納されます。 場合によっては、プロバイダーで使用するAPIアクセス トークンも含まれます。	Y	N	N	N	Y
last_ip	文字列	ユーザーが最後にログインした際のIPアドレス。	はい	いいえ	いいえ	いいえ	はい
last_login	日付/時刻	ユーザーが最後にログインした日時を示すタイムスタンプ。ユーザーがブロックされている状態でログインした場合でも、ブロックされたセッションによって last_login は更新されます。Rule 内で user< オブジェクトを使用してこのプロパティを参照する場合、その値はそのルールをトリガーしたログインに対応します。これは、ルールがログイン後に実行されるためです。	はい	N	N	N	Y
last_password_reset	日時	ユーザーのパスワードが最後にリセットまたは変更された日時を示すタイムスタンプです。ユーザー作成時には、このフィールドは存在しません。このプロパティは、Database Connections でのみ使用できます。	N	N	N	N	Y
logins_count	整数	ユーザーのログイン回数。ユーザーがブロックされている状態でログインした場合、そのブロックされたセッションも logins_count にカウントされます。	Y	N	N	N	Y
multifactor	配列 (文字列)	ユーザーが登録している多要素認証プロバイダーの一覧。	N	N	N	N	Y
multifactor_last_modified	日時	ユーザーの多要素認証が最後に更新された日時。	N	N	N	N	Y
name	テキスト	ユーザーの氏名。	Y	Y	Y	Y	Y
nickname	text	ユーザーのニックネーム。	Y	Y	Y	Y	Y
phone_number	text	ユーザーの電話番号です。SMS接続を使用するユーザーにのみ有効です。	はい	はい	いいえ	いいえ	はい
phone_verified	真偽値	ユーザーの電話番号が確認済みかどうかを示します。SMS接続のユーザーでのみ有効です。	Y	Y	N	いいえ	はい
プロフィール画像	文字列	ユーザーのプロフィール画像のURL。	いいえ	はい	Y	Y	Y
tenant	テキスト	使用中のテナント名。	N	N	N	N	N
updated_at	日付時刻	ユーザーのプロファイルが最後に更新または変更された日時を示すタイムスタンプです。last_login の変更も更新と見なされるため、ほとんどの場合、updated_at は last_login と一致します。	Y	N	N	N	Y
user_id	テキスト	(一意) ユーザーの識別子。インポートにより、マッピングテーブルを使用せずに複数のシステム間でユーザーレコードを同期できます。	Y	N	Y	N	Y
user_metadata	object	勤務先の住所、自宅の住所、ユーザー設定など、ユーザーがアクセスできるものに影響しないユーザー情報を保存するカスタムフィールドです。詳しくは、メタデータの概要をご覧ください。	Y	はい	はい	はい	Y
username	テキスト	(一意の) ユーザーのユーザー名。	Y	Y	Y	N	Y

​

ユーザープロファイルのバリデーション

Auth0 では、ユーザープロファイル内の特定のフィールドに対して、所定のバリデーションスキーマを受け付けます。プロファイル属性値を設定する際の要件については、以下の表を参照してください。

保存時、すべての文字は小文字に変換されてユーザープロファイルに保存されます。

これはすべての Auth0データベース接続に当てはまります。Auth0 DB が正しい情報源ではない場合 (たとえば、インポートモードがオフのカスタム DB) や、Auth0 が正しい情報源ではないその他のソーシャル接続やエンタープライズ接続では、メールアドレスはそのまま保持され、小文字には変換されません。

Field	Type	Character Limit	Validation
email	email	ユーザー名/ローカル部分は最大 64 文字、ドメイン部分は最大 256 文字です。	JSON バリデーションスキーマ。
username	string	ユーザー名のデフォルトの許容長は 1 ～ 15 文字です。最大長は 128 文字です。	username フィールドでは、次の文字を使用できます。 英数字 (アクセント記号なし。自動的に小文字に変換) ; アットマーク (@) (ただしメールアドレスは不可) ; キャレット (^) ; ドル記号 ($) ; ドット (.) ; 感嘆符 (!) ; グレイヴアクセント (`) ; ハイフン (-) ; 番号記号 (#) ; プラス (+) ; 一重引用符 (’) ; チルダ (~) ; アンダースコア (_) ; これ以外の文字や記号は使用できません。また、Auth0 はカスタムデータベース入力のバリデーションやサニタイズを行いません。
phone_number	phone	標準化された形式 電話番号は E.164 形式である必要があります
password	string	設定可能な最小パスワード長は 1 バイト、最大は 72 バイトです。	標準文字: 33～126 の範囲の ASCII 文字が有効です。次を含みます。 A ～ Z の大文字, a ～ z の小文字, 0 ～ 9 の数字, 使用可能な特殊文字。
name	string	1～150 文字	すべての UTF-8 文字をサポート
nickname	string	1～350 文字	すべての UTF-8 文字をサポート
family_name	string	1～150 文字	すべての UTF-8 文字をサポート
given_name	string	1～150 文字	すべての UTF-8 文字をサポート

他に 3 つのフィールドがあります。これらは厳密にはユーザープロファイルの一部ではありませんが、ユーザーのインポート時には参考になる場合があります。

• password_hash (text): ユーザーの接続に対するハッシュ化済みパスワードです。ユーザー作成時、Auth0 はパスワードの保護に bcrypt を使用します。互換性のあるハッシュ化済みパスワードをインポートすると、ユーザーは既存のパスワードを維持でき、よりスムーズな体験を提供できます。互換性のあるパスワードは、bcrypt または を使用してハッシュ化し、saltRounds を 10 にする必要があります。なお、このフィールドを指定できるのはユーザーの初回インポート時のみで、後から更新することはできません。
• custom_password_hash (object): 別のアルゴリズムで作成された、ユーザーの接続に対するハッシュ化済みパスワードです。password_hash フィールドの代わりに使用します。一括インポート処理中は、ユーザーが最初にインポートされた custom_password_hash を使ってログインしていない場合に限り、custom_password_hash を更新できます。

​

詳細はこちら

• 一括ユーザーインポート
• 一括ユーザーインポートのデータベーススキーマと例