启用数据 API | MongoDB Atlas App Services Admin API 3.0 文档

启用数据 API 已弃用

发布 /groups/{groupId}/apps/{appId}/data_api/config

tokenAuth

创建应用程序的数据 API 配置。

路径参数

groupId 字符串必需

Atlas 项目/组 ID。
appId 字符串必需

您的应用程序的 ObjectID。App Services API 项目和应用程序 ID 部分演示了如何查找此值。

application/json

body 必需

终结点的有效配置对象。

残疾人布尔必需
versions array[string] 必需

受支持的数据API版本。

值为 v1。
return_type 字符串必需

数据API和自定义端点支持的数据格式。

值为 JSON 或 EJSON。
create_user_on_auth 布尔
run_as_user_id 字符串

应用程序用户的帐号 ID。如果已定义，端点将始终以指定的用户身份运行。
run_as_user_id_script_source 字符串

返回应用程序用户帐户 ID 的函数的字符串化源代码。如果已定义，端点将在每个请求时执行该函数，并以其 ID 为该函数所返回 ID 的对应用户的身份运行。
validation_method 字符串必需

值为 NO_VALIDATION、SECRET_AS_QUERY_PARAM 或 VERIFY_PAYLOAD。
secret_name 字符串

如果 validation_method 设置为 "SECRET_AS_QUERY_PARAM" 或 "VERIFY_PAYLOAD"，则这是授权请求的密钥的 name。
can_evaluate 对象

如果允许端点运行以响应传入请求，则 JSON 表达式的计算结果为 true。

响应

201 application/json

已创建
隐藏响应属性显示响应属性对象| null
- 残疾人布尔必需
- versions array[string] 必需
  
  受支持的数据API版本。
  
  值为 v1。
- return_type 字符串必需
  
  数据API和自定义端点支持的数据格式。
  
  值为 JSON 或 EJSON。
- create_user_on_auth 布尔
- run_as_user_id 字符串
  
  应用程序用户的帐号 ID。如果已定义，端点将始终以指定的用户身份运行。
- run_as_user_id_script_source 字符串
  
  返回应用程序用户帐户 ID 的函数的字符串化源代码。如果已定义，端点将在每个请求时执行该函数，并以其 ID 为该函数所返回 ID 的对应用户的身份运行。
- validation_method 字符串必需
  
  值为 NO_VALIDATION、SECRET_AS_QUERY_PARAM 或 VERIFY_PAYLOAD。
- secret_name 字符串
  
  如果 validation_method 设置为 "SECRET_AS_QUERY_PARAM" 或 "VERIFY_PAYLOAD"，则这是授权请求的密钥的 name。
- can_evaluate 对象
  
  如果允许端点运行以响应传入请求，则 JSON 表达式的计算结果为 true。

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": {}
}