Management API を使用したメタデータの管理

Management API を使用してメタデータを作成、更新、マージ、削除する方法について説明します。

​

ユーザーメタデータ

​

ユーザーのメタデータを作成する

以下のプロファイル情報を持つユーザーを作成するには、

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing"
    },
    "app_metadata": {
        "plan": "full"
    }
}

ユーザーを作成し、プロパティ値を設定するには、Management API /post_users エンドポイントに対して、次の POST 呼び出しを行います。

​

ユーザーのメタデータを更新する

Management API の /patch_users_by_id エンドポイントに PATCH リクエストを送信することで、ユーザーのメタデータを更新できます。

次のメタデータでユーザーを作成したとします。

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing"
    },
    "app_metadata": {
        "plan": "full"
    }
}

user_metadata を更新し、ユーザーの住所を第2階層のプロパティとして追加するには:

{
    "addresses": {
        "home": "123 Main Street, Anytown, ST 12345"
    }
}

次のPATCHリクエストを送信します：

ユーザーのプロファイルは次のようになります。

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing",
        "addresses": {
            "home": "123 Main Street, Anytown, ST 12345"
        }
    },
    "app_metadata": {
        "plan": "full"
    }
}

プロパティの値を null に設定した PATCH リクエスト (例: {user_metadata: {color: null}}) を送信すると、Auth0 はそのプロパティと値をデータベースから削除します。さらに、空のオブジェクトでメタデータ自体にパッチを適用すると、メタデータ全体が完全に削除されます。

​

ユーザーのメタデータをマージする

オブジェクトにマージされるのは、ルートレベルのプロパティのみです。下位レベルのプロパティはすべて置き換えられます。

たとえば、ユーザーの勤務先住所を追加の内部プロパティとして加えるには、addresses プロパティの内容をすべて含める必要があります。addresses オブジェクトはルートレベルのプロパティであるため、ユーザーを表す最終的な JSON オブジェクトにはマージされますが、その下位プロパティはマージされません。

{
  "user_metadata": {
    "addresses": {
      "home": "123 Main Street, Anytown, ST 12345",
      "work": "100 Industrial Way, Anytown, ST 12345"
    }
  }
}

したがって、対応する API への PATCH リクエストは次のようになります:

​

ユーザーのメタデータを削除する

次のように user_metadata を削除できます:

{
  "user_metadata": {}
}

​

アプリのメタデータ

空のオブジェクトでメタデータをパッチすると、メタデータは完全に削除されます。たとえば、このボディを送信すると、app_metadata 内のすべてが削除されます:

{
  "app_metadata": {}
}

​

クライアントメタデータ

​

クライアントメタデータを含めてアプリケーションを作成する

POST /api/v2/ applications エンドポイントを使用して新しいアプリケーションを作成する際に、clientMetadata オブジェクトを含めることができます。

​

クライアントメタデータを取得する

クライアントメタデータは、GET /api/v2/clients および GET /api/v2/client/{id} エンドポイントのレスポンスに含まれます。

​

クライアントメタデータを更新する

クライアントメタデータは、PATCH /api/v2/clients/{id} エンドポイントを使用して更新できます。clientMetadata property を持つアプリケーションオブジェクトを指定し、そのプロパティの値には、変更したいメタデータを含むオブジェクトを設定します。

変更前のアプリケーション:

{
  ...
  "name": "myclient",
  "client_metadata": {
    "mycolor": "red",
    "myflavor": "grape"
  }
  ...
}

リクエスト: PATCH /api/v2/client/myclientid123、ボディ:

{ "client_metadata": { "mycolor": "blue" } }

変更後のアプリケーション:

{
  "name": "myclient",
  "client_metadata": {
    "mycolor": "blue",
    "myflavor": "grape"
  }
  ...
}

​

クライアントメタデータのプロパティと値を削除する

クライアントメタデータのキーは、上記の「Update app_metadata」で説明されているように、PATCH リクエストを送信し、キーの値に null を指定することで削除できます。この挙動は、PATCH /api/v2/users/ エンドポイントにおける user_metadata および app_metadata プロパティの挙動と一致します。

​

詳しくはこちら

• Management API のアクセストークン
• アプリケーションメタデータを設定する