データ API を有効にする 非推奨

POST /groups/{groupId}/apps/{appId}/data_api/config
tokenAuth

アプリの データ API 構成を作成します。

path パラメータ

application/ JSON

body 必須

エンドポイントの有効な構成オブジェクト。

  • disabled ブール値 必須
  • バージョン array[string] 必須

    データAPIのサポートされているバージョン。

    値は v1 です。

  • return_type string 必須

    データAPIとカスタム エンドポイントによってサポートされているデータ形式。

    値は JSON または EJSON です。

  • create_user_on_auth ブール値
  • run_as_user_id string

    アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。

  • run_as_user_id_script_source string

    アプリケーション ユーザーのアカウント ID を返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返された ID を持つユーザーとして実行されます。

  • validation_method string 必須

    値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。

  • secret_name string

    validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレット の name です。

  • can_evaluate オブジェクト

    受信リクエストへの応答としてエンドポイントの実行が許可されている場合に true と評価される JSON 式。

応答

  • 201 application/ JSON

    作成済み

    応答属性の非表示 応答属性の表示 オブジェクト| null
    • disabled ブール値 必須
    • バージョン array[string] 必須

      データAPIのサポートされているバージョン。

      値は v1 です。

    • return_type string 必須

      データAPIとカスタム エンドポイントによってサポートされているデータ形式。

      値は JSON または EJSON です。

    • create_user_on_auth ブール値
    • run_as_user_id string

      アプリケーション ユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。

    • run_as_user_id_script_source string

      アプリケーション ユーザーのアカウント ID を返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返された ID を持つユーザーとして実行されます。

    • validation_method string 必須

      値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。

    • secret_name string

      validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレット の name です。

    • can_evaluate オブジェクト

      受信リクエストへの応答としてエンドポイントの実行が許可されている場合に true と評価される JSON 式。
POST /groups/{groupId}/apps/{appId}/data_api/config 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"disabled":true,"versions":["v1"],"return_type":"JSON","create_user_on_auth":true,"run_as_user_id":"string","run_as_user_id_script_source":"string","validation_method":"NO_VALIDATION","secret_name":"string","can_evaluate":{}}'
リクエスト例 
{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}
応答の例（201） 
{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}