認証
ユーザー管理
カスタマイズ
Auth0 AI
プラットフォームid によるユーザーの部分更新
ユーザーを更新します。
ルートレベルで更新できる属性は次のとおりです。
- app_metadata
- blocked
- email_verified
- family_name
- given_name
- name
- nickname
- password
- phone_number
- phone_verified
- picture
- username
- user_metadata
- verify_email
注意事項:
- 新しいオブジェクトのプロパティは、既存のプロパティを置き換えます。
- メタデータフィールドはこのルールの例外です（
user_metadataとapp_metadata）。これらのプロパティは置き換えられるのではなくマージされますが、マージが行われるのは第 1 レベルのみである点に注意してください。 - セカンダリ アイデンティティの
email、email_verified、phone_number、phone_verified、username、またはpasswordを更新する場合は、connectionプロパティも指定する必要があります。 emailまたはphone_numberを更新する場合は、必要に応じてclient_idプロパティを指定できます。email_verifiedの更新は、エンタープライズ接続およびパスワードレス SMS 接続ではサポートされていません。blockedをfalseに更新しても、誤った認証情報が過剰に入力されたことによるユーザーのブロック状態には影響しません。ユーザーの状態を変更するには、「User Blocks」API の “Unblock a user” エンドポイントを使用してください。- サポート対象の属性は、値に
nullを指定することで未設定にできます。
フィールドの更新（メタデータ以外のプロパティ）
ユーザーのメールアドレスを確認済みとしてマークするには、送信するリクエストボディを次のようにします。
{ "email_verified": true }
ユーザーメタデータのルートプロパティを更新する
テストユーザーが次の user_metadata を持っているとします。
{ "user_metadata" : { "profileCode": 1479 } }
addresses フィールドを追加するには、送信するリクエストボディを次のようにします。
{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
変更後のオブジェクトでは、user_metadata プロパティは次のようになります。
{
"user_metadata": {
"profileCode": 1479,
"addresses": { "work_address": "100 Industrial Way" }
}
}
ユーザーメタデータの内部プロパティを更新する
既存のユーザーメタデータに "home_address": "742 Evergreen Terrace" を追加したい場合（addresses プロパティを使用）は、addresses オブジェクト全体を送信する必要があります。これは第 1 レベルのオブジェクトであるため、オブジェクト自体はマージされますが、その内部プロパティはマージされません。送信するリクエストボディを次のようにします。
{
"user_metadata": {
"addresses": {
"work_address": "100 Industrial Way",
"home_address": "742 Evergreen Terrace"
}
}
}
変更後のオブジェクトでは、user_metadata プロパティは次のようになります。
{
"user_metadata": {
"profileCode": 1479,
"addresses": {
"work_address": "100 Industrial Way",
"home_address": "742 Evergreen Terrace"
}
}
}
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ヘッダー
このリクエストで使用するカスタムドメイン
3 - 255パスパラメータ
更新するユーザーの ID。
ボディ
このユーザーが読み取り専用アクセス権を持つユーザーメタデータ。
このユーザーが管理者によってブロックされているか（true）、ブロックされていないか（false）。
Auth0 クライアントID。メールアドレスの更新時にのみ有効です。
1このユーザー更新の対象となる接続名。
1このユーザーのメールアドレス。
このメールアドレスが確認済み（true）か未確認（false）か。false に設定されている場合、verify_email が true に設定されていない限り、ユーザーに確認メールは送信されません。
このユーザーの姓。
1 - 150このユーザーの名。
1 - 150このユーザーの名前。
1 - 300このユーザーの優先ニックネームまたは別名。
1 - 300このユーザーの新しいパスワード。データベース接続でのみ有効です。
1このユーザーの電話番号（E.164 の推奨形式に準拠）。
^\+[0-9]{1,15}$この電話番号が確認済みかどうか（true の場合は確認済み、false の場合は未確認）。
このユーザーの画像、写真、またはアバターの URL。
このユーザーが読み取り/書き込みアクセス権を持つユーザーメタデータ。
このユーザーの username。接続で username が必要な場合にのみ有効です。
1 - 128このユーザーの作成後に確認メールを送信するかどうか（true の場合は送信、false の場合は送信しない）。email_verified パラメーターの動作を上書きします。
電話番号の変更後にこのユーザーへテキストメッセージを送信するかどうか（true の場合は送信、false の場合は送信しない）。SMS 接続で電話番号を変更する場合にのみ有効です。
レスポンス
ユーザーが正常に更新されました。
このユーザーが読み取り専用でアクセスできるユーザーメタデータ。
このユーザーが管理者によってブロックされているかどうか（true の場合はブロック済み、false の場合はブロックされていない）。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーのメールアドレス。
このメールアドレスが確認済みかどうか（true の場合は確認済み、false の場合は未確認）。
このユーザーの姓。
このユーザーの名。
アカウントがリンクされている場合の、ユーザーのアイデンティティオブジェクトの配列。
このユーザーが最後にログインした IP アドレス。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーのログイン総数。
このユーザーが登録済みの多要素認証プロバイダーの一覧。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーの名前。
このユーザーの優先ニックネームまたは別名。
このユーザーの電話番号。E.164 の推奨形式に従います。
この電話番号が確認済みかどうか（true の場合は確認済み、false の場合は未確認）。
このユーザーの画像、写真、またはアバターの URL。
このユーザーが作成された日時（ISO_8601 形式）。
他の API とのやり取りで使用できる、このユーザーの ID。
このユーザーが読み取りおよび書き込みアクセス権を持つユーザーメタデータ。
このユーザーの username。