IDでUsersを更新

ユーザーを更新します。

root level で更新できる属性は次のとおりです。

• 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 レベルのみである点に注意してください。
• セカンダリ ID の email、email_verified、phone_number、phone_verified、username、または password を更新する場合は、connection プロパティも指定する必要があります。
• email または phone_number を更新する場合は、任意で client_id プロパティを指定できます。
• エンタープライズ接続およびパスワードレス sms 接続では、email_verified の更新はサポートされていません。
• blocked を false に更新しても、誤った資格情報が過剰に入力されたことによるユーザーのブロック状態には影響しません。ユーザーの状態を変更するには、「User Blocks」API の「Unblock a user」endpoint を使用してください。
• サポート対象の属性は、値に 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}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.UpdateAsync(
            id: "id",
            request: new UpdateUserRequestContent()
        );
    }

}

200

{
  "app_metadata": {},
  "blocked": true,
  "created_at": "2023-11-07T05:31:56Z",
  "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": "abc"
    }
  ],
  "last_ip": "<string>",
  "last_login": "2023-11-07T05:31:56Z",
  "last_password_reset": "2023-11-07T05:31:56Z",
  "logins_count": 123,
  "multifactor": [
    "<string>"
  ],
  "multifactor_last_modified": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "nickname": "<string>",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "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 client 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

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

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<date-time>

このユーザーが作成された日時。

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

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

email_verified · boolean · デフォルト: false

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

family_name · string

このユーザーの family name（姓／ラストネーム／surname）。

given_name · string

このユーザーの given name（名／ファーストネーム／フォアネーム）。

identities · object[]

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

Show child attributes

last_ip · string

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

last_login · string<date-time>

このユーザーが最後にログインした日時。

last_password_reset · string<date-time>

このユーザーのパスワードが最後にリセットされた日時。

logins_count · integer

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

multifactor · string[]

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

multifactor_last_modified · string<date-time>

このユーザーの多要素認証プロバイダーが最後に更新された日時。

name · string

このユーザーの名前。

nickname · string

このユーザーの希望するニックネームまたは別名。

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

このユーザーの電話番号。E.164 recommendation に準拠します。

phone_verified · boolean · デフォルト: false

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

picture · string

このユーザーのプロフィール画像、写真、またはアバターのURL。

updated_at · string<date-time>

このユーザーが最後に更新または変更された日時。

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

他の API と連携する際に使用できる、このユーザーの ID。

user_metadata · object

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

username · string · デフォルト: johndoe

このユーザーのユーザー名。