id によるユーザーの部分更新

ユーザーを更新します。

ルートレベルで更新できる属性は次のとおりです。

• app_metadata
• blocked
• email
• 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"
    }
  }
}

PATCH https://{tenantDomain}/api/v2/users/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateUserRequestContent{}
    client.Users.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_metadata": {},
  "blocked": false,
  "client_id": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
  "connection": "Initial-Connection",
  "email": "[e-mail]",
  "email_verified": false,
  "family_name": "Doe",
  "given_name": "John",
  "name": "John Doe",
  "nickname": "Johnny",
  "password": "secret",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png",
  "user_metadata": {},
  "username": "johndoe",
  "verify_email": false,
  "verify_phone_number": false
}
'

import requests

url = "https://{tenantDomain}/api/v2/users/{id}"

payload = {
    "app_metadata": {},
    "blocked": False,
    "client_id": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
    "connection": "Initial-Connection",
    "email": "[e-mail]",
    "email_verified": False,
    "family_name": "Doe",
    "given_name": "John",
    "name": "John Doe",
    "nickname": "Johnny",
    "password": "secret",
    "phone_number": "[phone]",
    "phone_verified": False,
    "picture": "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png",
    "user_metadata": {},
    "username": "johndoe",
    "verify_email": False,
    "verify_phone_number": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'app_metadata' => [
        
    ],
    'blocked' => false,
    'client_id' => 'DaM8bokEXBWrTUFCiJjWn50jei6ardyX',
    'connection' => 'Initial-Connection',
    'email' => '[e-mail]',
    'email_verified' => false,
    'family_name' => 'Doe',
    'given_name' => 'John',
    'name' => 'John Doe',
    'nickname' => 'Johnny',
    'password' => 'secret',
    'phone_number' => '[phone]',
    'phone_verified' => false,
    'picture' => 'https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png',
    'user_metadata' => [
        
    ],
    'username' => 'johndoe',
    'verify_email' => false,
    'verify_phone_number' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/users/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_metadata\": {},\n  \"blocked\": false,\n  \"client_id\": \"DaM8bokEXBWrTUFCiJjWn50jei6ardyX\",\n  \"connection\": \"Initial-Connection\",\n  \"email\": \"[e-mail]\",\n  \"email_verified\": false,\n  \"family_name\": \"Doe\",\n  \"given_name\": \"John\",\n  \"name\": \"John Doe\",\n  \"nickname\": \"Johnny\",\n  \"password\": \"secret\",\n  \"phone_number\": \"[phone]\",\n  \"phone_verified\": false,\n  \"picture\": \"https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png\",\n  \"user_metadata\": {},\n  \"username\": \"johndoe\",\n  \"verify_email\": false,\n  \"verify_phone_number\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_metadata\": {},\n  \"blocked\": false,\n  \"client_id\": \"DaM8bokEXBWrTUFCiJjWn50jei6ardyX\",\n  \"connection\": \"Initial-Connection\",\n  \"email\": \"[e-mail]\",\n  \"email_verified\": false,\n  \"family_name\": \"Doe\",\n  \"given_name\": \"John\",\n  \"name\": \"John Doe\",\n  \"nickname\": \"Johnny\",\n  \"password\": \"secret\",\n  \"phone_number\": \"[phone]\",\n  \"phone_verified\": false,\n  \"picture\": \"https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png\",\n  \"user_metadata\": {},\n  \"username\": \"johndoe\",\n  \"verify_email\": false,\n  \"verify_phone_number\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "app_metadata": {},
  "blocked": true,
  "created_at": "<string>",
  "email": "[e-mail]",
  "email_verified": false,
  "family_name": "<string>",
  "given_name": "<string>",
  "identities": [
    {
      "access_token": "<string>",
      "access_token_secret": "<string>",
      "connection": "<string>",
      "isSocial": true,
      "profileData": {
        "email": "<string>",
        "email_verified": true,
        "family_name": "<string>",
        "given_name": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "phone_verified": true,
        "username": "johndoe"
      },
      "refresh_token": "<string>",
      "user_id": "<string>"
    }
  ],
  "last_ip": "<string>",
  "last_login": "<string>",
  "last_password_reset": "<string>",
  "logins_count": 123,
  "multifactor": [
    "<string>"
  ],
  "multifactor_last_modified": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "<string>",
  "updated_at": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "user_metadata": {},
  "username": "johndoe"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ヘッダー

auth0-custom-domain · string

このリクエストで使用するカスタムドメイン

Required string length: 3 - 255

パスパラメータ

id · string · 必須

更新するユーザーの ID。

ボディ

application/jsonapplication/x-www-form-urlencoded

app_metadata · object

このユーザーが読み取り専用アクセス権を持つユーザーメタデータ。

blocked · boolean · デフォルト: false

このユーザーが管理者によってブロックされているか（true）、ブロックされていないか（false）。

client_id · string · デフォルト: DaM8bokEXBWrTUFCiJjWn50jei6ardyX

Auth0 クライアントID。メールアドレスの更新時にのみ有効です。

Minimum string length: 1

connection · string · デフォルト: Initial-Connection

このユーザー更新の対象となる接続名。

Minimum string length: 1

email · string<email> | null · デフォルト: [e-mail]

このユーザーのメールアドレス。

email_verified · boolean · デフォルト: false

このメールアドレスが確認済み（true）か未確認（false）か。false に設定されている場合、verify_email が true に設定されていない限り、ユーザーに確認メールは送信されません。

family_name · string | null · デフォルト: Doe

このユーザーの姓。

Required string length: 1 - 150

given_name · string | null · デフォルト: John

このユーザーの名。

Required string length: 1 - 150

name · string | null · デフォルト: John Doe

このユーザーの名前。

Required string length: 1 - 300

nickname · string | null · デフォルト: Johnny

このユーザーの優先ニックネームまたは別名。

Required string length: 1 - 300

password · string | null · デフォルト: secret

このユーザーの新しいパスワード。データベース接続でのみ有効です。

Minimum string length: 1

phone_number · string | null · デフォルト: [phone]

このユーザーの電話番号（E.164 の推奨形式に準拠）。

Pattern: ^\+[0-9]{1,15}$

phone_verified · boolean · デフォルト: false

この電話番号が確認済みかどうか（true の場合は確認済み、false の場合は未確認）。

picture · string<strict-uri> | null · デフォルト: https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png

このユーザーの画像、写真、またはアバターの URL。

user_metadata · object

このユーザーが読み取り/書き込みアクセス権を持つユーザーメタデータ。

username · string | null · デフォルト: johndoe

このユーザーの username。接続で username が必要な場合にのみ有効です。

Required string length: 1 - 128

verify_email · boolean · デフォルト: false

このユーザーの作成後に確認メールを送信するかどうか（true の場合は送信、false の場合は送信しない）。email_verified パラメーターの動作を上書きします。

verify_phone_number · boolean · デフォルト: false

電話番号の変更後にこのユーザーへテキストメッセージを送信するかどうか（true の場合は送信、false の場合は送信しない）。SMS 接続で電話番号を変更する場合にのみ有効です。

レスポンス

200

application/json

ユーザーが正常に更新されました。

app_metadata · object

このユーザーが読み取り専用でアクセスできるユーザーメタデータ。

blocked · boolean

このユーザーが管理者によってブロックされているかどうか（true の場合はブロック済み、false の場合はブロックされていない）。

created_at · string object

このユーザーが作成された日時（ISO_8601 形式）。

email · string<email> · デフォルト: [e-mail]

このユーザーのメールアドレス。

email_verified · boolean · デフォルト: false

このメールアドレスが確認済みかどうか（true の場合は確認済み、false の場合は未確認）。

family_name · string

このユーザーの姓。

given_name · string

このユーザーの名。

identities · object[]

アカウントがリンクされている場合の、ユーザーのアイデンティティオブジェクトの配列。

Show child attributes

last_ip · string

このユーザーが最後にログインした IP アドレス。

last_login · string object

このユーザーが作成された日時（ISO_8601 形式）。

last_password_reset · string object

このユーザーが作成された日時（ISO_8601 形式）。

logins_count · integer

このユーザーのログイン総数。

multifactor · string[]

このユーザーが登録済みの多要素認証プロバイダーの一覧。

multifactor_last_modified · string object

このユーザーが作成された日時（ISO_8601 形式）。

name · string

このユーザーの名前。

nickname · string

このユーザーの優先ニックネームまたは別名。

phone_number · string · デフォルト: [phone]

このユーザーの電話番号。E.164 の推奨形式に従います。

phone_verified · boolean · デフォルト: false

この電話番号が確認済みかどうか（true の場合は確認済み、false の場合は未確認）。

picture · string

このユーザーの画像、写真、またはアバターの URL。

updated_at · string object

このユーザーが作成された日時（ISO_8601 形式）。

user_id · string · デフォルト: auth0|507f1f77bcf86cd799439020

他の API とのやり取りで使用できる、このユーザーの ID。

user_metadata · object

このユーザーが読み取りおよび書き込みアクセス権を持つユーザーメタデータ。

username · string · デフォルト: johndoe

このユーザーの username。