一括インポートでのファイルサイズは、500 KBが上限です。データがこのサイズを上回る場合には、複数のインポートを開始する必要があります。
ユーザーのJSONスキーマ
以下のJSONスキーマは有効なユーザーを記述しています。プロパティ
ユーザーは以下のプロパティを使用してインポートすることができます。app_metadataとuser_metadataの詳細については、「ユーザープロファイルでのメタデータの使い方」をお読みください。
アプリメタデータ
user.app_metadataオブジェクトには、以下のいずれのプロパティも含めてはいけません 。
__tenant_idblockedclientIDcreated_atemail_verifiedemailglobalClientIDglobal_client_ididentitieslastIPlastLoginloginsCountmetadatamultifactor_last_modifiedmultifactorupdated_atuser_id
カスタムパスワードハッシュ
user.custom_password_hashオブジェクトは、ユーザーのパスワードハッシュが他のアルゴリズムで作成された場合に、user.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に設定します。
対応しているハッシュアルゴリズム
Auth0は現在、以下のユーザーパスワードハッシュのインポートに対応しています。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には以下の1つのプレフィックスが含まれなければなりません。$2a$$2b$$2y$
$2$、$sha1$や$2x$など、他のプレフィックスには現在対応していません。
hello」の文字列から生成したものです:
$2b$10$nFguVi9LsCAcvTZFKQlRKeLVydo8ETv483lkNsSFI/Wl1Rz1Ypo1K
algorithmがhmacに設定されている場合には:
algorithmがldapに設定されている場合には:
HMAC
algorithmがmd4、md5、sha1、sha256、またはsha512に設定されている場合には:
-
hash.encodingはhexまたはbase64でなければなりません。 -
hash.digestは必須で、以下のいずれかでなければなりません。md4md5ripemd160sha1sha224sha256sha384sha512whirlpool
-
hash.key.valueは必須です。 -
hash.key.encodingはbase64、hex、またはutf8でなければなりません。
LDAP
algorithmがpbkdf2に設定されている場合には:
hash.encodingはutf8でなければなりません。saltは使用できません。hash.valueでは、IETF Datatrackerに掲載のRFC-2307セクション5.3で説明されている形式を厳守する必要があります。- スキーマは
md5|smd5|sha*|ssha*のいずれかになります。詳細についてはこちらを参照してください。 - cryptスキーマは、動作がシステムや実装に依存するため、非対応 であることに注意してください。詳細については、Open LDAPが提供するAdmin Guideの「4.4.2.CRYPT password storage scheme」をお読みください。
MDおよびSHA
algorithmがscryptに設定されている場合には:
hash.encodingはhexまたはbase64でなければなりません。
PBKDF2
user.mfa_factors配列には、ユーザーの登録が含まれます。詳細については、「Auth0での多要素認証」をお読みください。登録をインポートすると、インポート後にユーザーがMFAに再登録する必要がなくなります。以下の登録タイプに対応しています。
-
hash.encodingはutf8でなければなりません。 -
hash.saltは使用できません。 -
hash.valueは、GitHubのP-H-C / phc-string-formatで指定されているように、PHC文字列形式でなければなりません -
hash.valueにはB64エンコードされたソルトが含まれなければなりません(埋め込み文字「=」を省略したbase64で、PHCのドキュメントで指定されています)。 -
hash.valueには、i(iterations)と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
hash.encodingはhexまたはbase64でなければなりません。keylenパラメーターは必須です。costパラメーターを使用することができます。指定しない場合には、デフォルトの16384が使用されます。blockSizeパラメーターを使用することができます。指定しない場合には、デフォルトの8が使用されます。parallelizationパラメーターを使用することができます。指定しない場合には、デフォルトの1が使用されます。
MFA要素
以下の内容のあるファイルが有効です。例
基本例
以下は、提供されたハッシュのあるユーザーの例です。カスタムパスワードハッシュの例
ご推察のとおり、user.mfa_factors配列は、ユーザーのMFA登録を提供できるようにします。以下の登録タイプに対応しています。
以下は、MFA要素のあるユーザーの例です。
MFA要素の例
- 電話:SMSベースの検証に使用されます。
- TOTP:MFAタイプのアプリ(Google Authenticator、Microsoft Authenticator、Authy、1Password、LastPass)で使用するOTPシークレットです。
- メール:メールベースの検証に使用されます。