カスタムユーザーデータの構成 非推奨

PATCH /groups/{groupId}/apps/{appId}/custom_user_data
tokenAuth

Atlas App Services アプリのカスタム ユーザー データ構成を変更します。

path パラメータ

application/ JSON

body

  • database_name string

    カスタム ユーザー データが含まれるデータベースの名前。

  • collection_name string

    カスタム ユーザー データが含まれるコレクションの名前。

  • user_id_field string

    すべてのカスタム ユーザー データ ドキュメントに表示され、各ドキュメントに対応するユーザーのユーザー アカウント ID が含まれるフィールドの名前。

  • enabled ブール値

    true の場合、カスタム ユーザー データが有効になります。

  • mongo_service_id string

    リンクされたMongoDBデータソースの _id 値。

    すべてのサービスを取得するエンドポイントを使用してサービスを一覧表示できます。

    データソースは、type が「mongodb-atlas」であるサービスです。 trigger にリンクするデータソースには _id 値を使用します。

  • on_user_creation_function_id string

    新しいユーザーが登録されるたびに実行されるユーザー作成関数の _id 値。

応答

  • 204

    成功

PATCH /groups/{groupId}/apps/{appId}/custom_user_data 
curl \
 --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/custom_user_data' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"myapp","collection_name":"users","user_id_field":"user_account_id","enabled":true,"mongo_service_id":"63c060ed32043ef4c93c2a9c","on_user_creation_function_id":"63c055d8019a6ab879f661d6"}'
リクエスト例 
{
  "database_name": "myapp",
  "collection_name": "users",
  "user_id_field": "user_account_id",
  "enabled": true,
  "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}