ユーザーメタデータ
ユーザーのメタデータを作成する
以下のプロファイル情報を持つユーザーを作成するには、/post_users エンドポイントに対して、次の POST 呼び出しを行います。
Auth0 CLI を使用していますか?まだセットアップしていない場合は、このコマンドを実行する前に CLI セッションをセットアップして認証してください。
ユーザーのメタデータを更新する
Management API の/patch_users_by_id エンドポイントに PATCH リクエストを送信することで、ユーザーのメタデータを更新できます。
次のメタデータでユーザーを作成したとします。
user_metadata を更新し、ユーザーの住所を第2階層のプロパティとして追加するには:
PATCHリクエストを送信します:
ユーザーのプロファイルは次のように表示されます。
ユーザーのメタデータをマージする
オブジェクトにマージされるのは、ルートレベルのプロパティのみです。下位レベルのプロパティはすべて置き換えられます。 たとえば、ユーザーの勤務先住所を追加の内部プロパティとして加えるには、addresses プロパティの内容をすべて含める必要があります。addresses オブジェクトはルートレベルのプロパティであるため、ユーザーを表す最終的な JSON オブジェクトにはマージされますが、その下位プロパティはマージされません。
PATCH リクエストは次のようになります:
ユーザーのメタデータを削除する
次のようにuser_metadata を削除できます:
アプリのメタデータ
空のオブジェクトでメタデータをパッチすると、メタデータは完全に削除されます。たとえば、このボディを送信すると、app_metadata 内のすべてが削除されます:
クライアントメタデータ
クライアントメタデータを含めてアプリケーションを作成する
POST /api/v2/ applications エンドポイントを使用して新しいアプリケーションを作成する際に、clientMetadata オブジェクトを含めることができます。
クライアントメタデータを取得する
クライアントメタデータは、GET /api/v2/clients および GET /api/v2/client/{id} エンドポイントのレスポンスに含まれます。
クライアントメタデータを更新する
クライアントメタデータは、PATCH /api/v2/clients/{id} エンドポイントを使用して更新できます。clientMetadata property を持つアプリケーションオブジェクトを指定し、そのプロパティの値には、変更したいメタデータを含むオブジェクトを設定します。
変更前のアプリケーション:
PATCH /api/v2/client/myclientid123、ボディ:
クライアントメタデータのプロパティと値を削除する
クライアントメタデータのキーは、上記の「Update app_metadata」で説明されているように、PATCH リクエストを送信し、キーの値に null を指定することで削除できます。この挙動は、PATCH /api/v2/users/ エンドポイントにおける user_metadata および app_metadata プロパティの挙動と一致します。