一括インポートのファイルサイズ上限は 500KB です。データがこのサイズを超える場合は、複数回に分けてインポートを実行する必要があります。
ユーザー JSON スキーマ
プロパティ
app_metadata と user_metadata の詳細については、ユーザープロフィールにおけるメタデータの仕組みを理解する を参照してください。
アプリメタデータ
user.app_metadata オブジェクトには、次のプロパティを含めないでください。
__tenant_idblockedclientIDcreated_atemail_verifiedemailglobalClientIDglobal_client_ididentitieslastIPlastLoginloginsCountmetadatamultifactor_last_modifiedmultifactorupdated_atuser_id
カスタムパスワードハッシュ
user.password_hash プロパティの代わりに user.custom_password_hash オブジェクトを使用できます。なお、このフィールドと password_hash は相互に排他的です。
user.custom_password_hash オブジェクトには、次のプロパティがあります。
カスタムパスワードハッシュを更新する
custom_password_hash を使ってログインしていない場合は、custom_password_hash を更新できます。たとえば、以下の JSON を custom_password_hash に異なる値を指定して /api/v2/jobs/users-imports エンドポイントに 2 回送信できます。2 回目の送信時には、upsert フラグを true に設定してください。
サポートされているハッシュアルゴリズム
custom_password_hash を指定する際は、以下のセクションを参照してください。
Argon2
algorithm が argon2 に設定されている場合:
hash.encodingはutf8でなければなりません。hash.saltは使用できません。hash.valueは、GitHub の P-H-C / phc-string-format で規定されている PHC 文字列形式である必要があります。また、GitHub の Auth0 / magic で指定されている要件にも準拠している必要があります。hash.valueには、base64 エンコードされた ソルト (PHCドキュメントで規定されているとおり) を含める必要があります。
bcrypt
algorithm が bcrypt に設定されている場合:
-
hash.encodingはutf8である必要があります。 -
hash.saltは、ソルト のエンコーディングおよび位置とあわせて使用できます。 -
hash.valueには、次のいずれかのプレフィックスが含まれている必要があります。$2a$$2b$$2y$
$2$、$sha1$、$2x$などの他のプレフィックスはサポートされていません。
hello から生成されたものです。
$2b$10$nFguVi9LsCAcvTZFKQlRKeLVydo8ETv483lkNsSFI/Wl1Rz1Ypo1K
bcrypt アルゴリズムは、パスワードハッシュの計算時または比較時に最大 72 バイトの入力を処理します。また、salt.value の長さもこの 72 バイトの入力上限に含まれます。72 バイトの上限を超える入力は切り詰められます。たとえば、ソルト が 10 バイトを使用する場合、ハッシュ化または比較に使用できるパスワードの最大長は 62 バイトです。
この短縮後の上限を超えるパスワードは切り詰められるため、パスワード強度が低下したり、ハッシュ衝突が発生したりする可能性があります。ハッシュ化する前に、必ずパスワードの長さを検証してください.
HMAC
algorithm が hmac に設定されている場合:
-
hash.encodingはhexまたはbase64のいずれかである必要があります。 -
hash.digestは必須であり、次のいずれかである必要があります。md4md5ripemd160sha1sha224sha256sha384sha512whirlpool
-
hash.key.valueは必須です。 -
hash.key.encodingはbase64、hex、utf8のいずれかである必要があります。
LDAP
algorithm が ldap に設定されている場合:
hash.encodingはutf8でなければなりません。ソルトは使用できません。hash.valueは、IETF Datatracker の RFC-2307 section-5.3 で定義されている形式に準拠している必要があります。- スキームは
md5|smd5|sha*|ssha*のいずれかである必要があります。詳細については こちら を参照してください。 - crypt スキームは、システムや実装によって動作が異なるため サポートされていません。詳細については、Open LDAP Admin Guide - 14.4.2. CRYPT password storage scheme を参照してください。
MD または SHA
algorithm が md4、md5、sha1、sha256、または sha512 に設定されている場合:
hash.encodingはhexまたはbase64のいずれかである必要があります。
PBKDF2
algorithm が pbkdf2 に設定されている場合:
-
hash.encodingはutf8である必要があります。 -
hash.saltは使用できません。 -
hash.valueは、GitHub の P-H-C / phc-string-format で規定されている PHC 文字列形式である必要があります。 -
hash.valueには、B64 エンコードされた ソルト (PHCドキュメントで指定されているとおり、パディング文字=を除いた base64) を含める必要があります。 -
hash.valueにはi(反復回数) およびl(keylen) パラメーターを含める必要があります。これらのパラメーターを省略した場合、デフォルトでi=100000およびl=64が使用されます。 -
idはpbkdf2-<digest>形式 (pbkdf2-sha512、pbkdf2-md5など) である必要があります。サポートされているダイジェストは次のとおりです。RSA-MD4RSA-MD5RSA-MDC2RSA-RIPEMD160RSA-SHA1RSA-SHA1-2RSA-SHA224RSA-SHA256RSA-SHA384RSA-SHA512md4md4WithRSAEncryptionmd5md5WithRSAEncryptionmdc2mdc2WithRSAripemdripemd160ripemd160WithRSArmd160sha1sha1WithRSAEncryptionsha224sha224WithRSAEncryptionsha256sha256WithRSAEncryptionsha384sha384WithRSAEncryptionsha512sha512WithRSAEncryptionssl3-md5ssl3-sha1whirlpool
scrypt
algorithm が scrypt に設定されている場合:
hash.encodingはhexまたはbase64のいずれかである必要があります。keylenパラメーターは必須です。costパラメーターは省略可能です。指定しない場合、デフォルト値は 16384 です。blockSizeパラメーターは省略可能です。指定しない場合、デフォルト値は 8 です。parallelizationパラメーターは省略可能です。指定しない場合、デフォルト値は 1 です。
MFA ファクター
user.mfa_factors 配列には、ユーザーの 登録情報が含まれます。詳細については、Auth0 の多要素認証 を参照してください。登録情報をインポートすると、インポート後にユーザーが MFA に再登録する必要がなくなります。サポートされている登録タイプは次のとおりです。
例
基本的な例
カスタムパスワードハッシュの例
MFA ファクターの例
user.mfa_factors 配列では、ユーザーの MFA 登録情報を指定できます。サポートされている登録タイプは次のとおりです。
- 電話番号: SMS ベースの認証に使用します。
- TOTP: MFA アプリ (Google Authenticator、Microsoft Authenticator、Authy、1Password、LastPass) で使用する OTP シークレットです。
- メールアドレス: メールベースの認証に使用します。