ユーザーの更新
Auth0ユーザーの属性を更新します。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Pass Empty Values?(空の値を渡す?) |
フィールドの更新をスキップする代わりに、リモートシステムに空の値を渡すかどうかを示します。
このオプションはリストまたはオブジェクトにも影響しますが、ドロップダウンタイプには影響しません。 |
ドロップダウン |
TRUE |
入力
セカンダリIDの[Email(メール)]、[Email Verified(メールが確認済み)]、[Phone Number(電話番号)]、[Phone Verified(電話が確認済み)]、[Username(ユーザー名)]、または[Password(パスワード)]フィールドを更新する場合は、[Connection(接続)]フィールドを指定する必要があります。
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
User(ユーザー) |
|||
ID |
ユーザーの一意識別子。 |
テキスト |
TRUE |
User Fields(ユーザーフィールド) |
|||
Name(名前) |
ユーザーの名前。 |
テキスト |
FALSE |
Email Verified(メールが確認済み) |
このメールアドレスが確認済みかどうかを示します。 これがfalseであるか、指定されていない場合、ユーザーは作成後に検証メールを受信します。 エンタープライズまたはパスワードなしのSMS接続では、このオプションの更新はサポートされません。 |
True/False |
FALSE |
Phone Verified(電話が確認済み) |
この電話番号が確認済みかどうかを示します。 この入力は、[Passwordless - SMS(パスワードなし - SMS)]オプションを選択した場合にのみ使用できます。 |
True/False |
FALSE |
Username(ユーザー名) |
ユーザーのユーザー名。 このフィールドは、接続にユーザー名の入力が必要な場合にのみ有効です。 |
テキスト |
FALSE |
Given Name(名) |
ユーザーの名。 |
テキスト |
FALSE |
App Metadata(アプリメタデータ) |
ユーザーに関する情報を保存するカスタムフィールド。これらのフィールドはユーザーのアカウントアクセスに影響します。たとえば、ユーザーのサポートプラン、セキュリティロール(Auth0権限付与コア機能を使用していない場合)、アクセスコントロールグループなどです。 メタデータストレージの詳細については、「ユーザープロファイルでメタデータがどのように機能するかを理解する」を参照してください。 この入力には特定の形式は必要ありません。 子のメタデータを更新すると、既存のコンテンツが置き換えられる代わりに、既存のコンテンツと新しいコンテンツがマージされます。 |
オブジェクト |
FALSE |
Metadata(メタデータ) |
ユーザーに関する情報を保存するカスタムフィールド。これらのフィールドはユーザーのアカウントアクセスに影響を与えません。たとえば、ユーザーの勤務先住所、自宅住所、その他の基本設定などです。 メタデータストレージの詳細については、「ユーザープロファイルでメタデータがどのように機能するかを理解する」を参照してください。 この入力には特定の形式は必要ありません。 子のメタデータを更新すると、既存のコンテンツが置き換えられる代わりに、既存のコンテンツと新しいコンテンツがマージされます。 |
オブジェクト |
FALSE |
Email(メール) |
ユーザーのメールアドレス。 このオプションを更新する場合は、オプションで[Client ID(クライアントID)]プロパティを指定できます。 |
テキスト |
FALSE |
Family Name(姓) |
ユーザーの姓。 |
テキスト |
FALSE |
Nickname(ニックネーム) |
ユーザーのニックネーム。 |
テキスト |
FALSE |
Blocked(ブロック) |
管理者がこのユーザーをブロックしているかどうかを示します。 正しくない資格情報の数が過剰であることが原因でユーザーがブロックされている場合、このオプションをfalseに更新しても状態は変更されません。この場合は、「自動的にブロックされたユーザーのブロックを解除する」を参照してください。 |
True/False |
FALSE |
Picture(写真) |
ユーザーの写真を含むURI(Uniform Resource Identifier)。 例:https://www.akc.org/wp-content/uploads/2017/11/Pomeranian-On-White-01.jpg |
テキスト |
FALSE |
Verify Email(メールを確認) |
Auth0がアカウントを作成した後にユーザーに検証メールを送信するかどうかを示します(送信する場合はtrue、送信しない場合はfalse)。 これは[Email Verified(メールが確認済み)]入力で設定された動作を上書きします。 |
True/False |
FALSE |
Phone Number (電話番号) |
ユーザーの電話番号。 番号の形式は、国際的に広く使用されているE.164勧告(地域コードとエリアコードを含む12桁の番号)に従う必要があります。例:+15559876543。 この入力は、[Passwordless - SMS(パスワードなし - SMS)]オプションを選択した場合にのみ使用できます。 このオプションを更新する場合は、オプションで[Client ID(クライアントID)]プロパティを指定できます。 |
テキスト |
FALSE |
Password(パスワード) |
ユーザーアカウントの初期パスワード。 |
テキスト |
FALSE |
Client ID(クライアントID) |
Auth0アプリケーションに関連付けられているクライアントID。 |
テキスト |
FALSE |
Connection(接続) |
このユーザーが更新される必要がある接続の名前。 カードは、Auth0 APIから利用可能な選択肢を動的にフェッチします。 |
ドロップダウン |
FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
ユーザー |
||
Raw Output(未加工出力) |
ユーザーの更新後にAPIから返される未加工のレスポンスオブジェクト。 |
オブジェクト |
ID |
ユーザーの一意の外部ID。 |
テキスト |
Email(メール) |
ユーザーのメールアドレス。 |
テキスト |
Email Verified(メールが確認済み) |
このメールアドレスが確認済みかどうかを示します。 これがfalseであるか、指定されていない場合、ユーザーは作成後に検証メールを受信します。 |
True/False |
Username(ユーザー名) |
ユーザーのユーザー名。 |
テキスト |
Phone Number(電話番号) |
ユーザーの電話番号。 この出力値はSMS接続を持つユーザーにのみ表示されます。 |
テキスト |
Phone Verified(電話が確認済み) |
この電話番号が確認済みかどうかを示します。 |
True/False |
Created At(作成日時) |
ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。 |
テキスト |
Updated At(最終更新日) |
ユーザーのプロファイルが直近に更新または変更された日時を示すタイムスタンプ。 [Last Login(前回のログイン)]の変更は更新と見なされます。そのため、ほとんどの場合、[Updated At(最終更新日)]は[Last Login(前回のログイン)]に一致します。 |
テキスト |
Identities(ID) |
ユーザーを最初に認証したIDプロバイダーから取得された情報を格納します。 |
オブジェクトのリスト |
Connection(接続) |
ユーザーの認証に使用されるAuth0接続の名前。 |
テキスト |
User ID(ユーザーID) |
ユーザーのこの接続またはプロバイダー用の一意のID。 |
テキスト |
Provider(プロバイダー) |
ユーザーを認証したエンティティの名前。たとえば、Facebook、Google、SAML、または独自のプロバイダー名です。 |
テキスト |
Is Social(ソーシャルか) |
接続がソーシャルプロバイダーによって認証されたかどうかを示します。 |
True/False |
App Metadata(アプリメタデータ) |
アプリケーションのコア機能に影響を与えるユーザー関連データ。 |
オブジェクト |
Metadata(メタデータ) |
アプリケーションのコア機能に影響を与えないユーザー関連データ。 |
オブジェクト |
Picture(写真) |
ユーザーの写真を含むURI(Uniform Resource Identifier)。 例:https://www.akc.org/wp-content/uploads/2017/11/Pomeranian-On-White-01.jpg |
テキスト |
Name(名前) |
ユーザーの名前。 |
テキスト |
Nickname(ニックネーム) |
ユーザーのニックネーム。 |
テキスト |
Multifactor(多要素) |
ユーザーが登録している多要素プロバイダーのリスト。 |
オブジェクトのリスト |
Last IP(前回のIP) |
ユーザーの前回のサインイン施行に関連付けられているIPアドレス。 |
テキスト |
Last Login(前回のログイン) |
ユーザーの前回のサインイン日時を示すタイムスタンプ。 |
テキスト |
Logins Count(ログイン数) |
ユーザーがサインインした回数。 |
数値 |
Blocked(ブロック) |
管理者がこのユーザーをブロックしているかどうかを示します。 |
True/False |
Given Name(名) |
ユーザーの名。 |
テキスト |
Family Name(姓) |
ユーザーの姓。 |
テキスト |