HTTPS 端点配置文件

Atlas Device Sync 、 Atlas Edge Server 、 Data API和HTTPS endpoints均已弃用。有关详细信息，请参阅弃用页面。

app/
└── https_endpoints/
    ├── config.json
    └── data_api_config.json

自定义 HTTPS 端点配置

在 https_endpoints/config.json中将应用程序的所有HTTPS endpoints的配置定义为一个数组。

[
  {
    "route": "<Endpoint Route Name>",
    "http_method": "<HTTP method>",
    "function_name": "<Endpoint function name",
    "validation_method": "<Authorization scheme>",
    "secret_name": "<Validation Secret Name>",
    "respond_result": <boolean>,
    "fetch_custom_user_data": <boolean>,
    "create_user_on_auth": <boolean>,
    "disabled": <boolean>
  }
]

字段	说明
`route` `string`	端点路由。
`http_method` `string`	HTTP方法的类型端点处理。指定``以处理具有单个端点的所有方法。以下之一： `"GET"` `"POST"` `"PUT"` `"PATCH"` `"DELETE"` `"DELETE"` `""`
`function_name` `string`	与端点关联的函数的名称。该函数应使用端点函数签名。
`validation_method` `string`	用于验证传入请求的端点授权方案。以下之一： `"SECRET_AS_QUERY_PARAM"` `"VERIFY_PAYLOAD"` `"NO_VALIDATION"`
`secret_name` `string`	包含字符串的密钥名称。如果`validation_method`设置为`SECRET_AS_QUERY_PARAM`或`VERIFY_PAYLOAD` ，则此密钥用于授权请求。
`respond_result` `boolean`	如果为`true` ，端点将向客户端返回可自定义的 HTTP 响应。您可以通过调用响应对象上的方法来配置响应。如果未配置响应，端点将返回`200 - Ok`响应，其中包含从端点函数返回的值作为请求正文。如果`false` ，则请求将返回`204 - No Content`响应，正文中不含数据。
`fetch_custom_user_data` `boolean`	如果为`true` ，则可通过`context.user.custom_data`获取经过身份验证的用户的自定义用户数据文档。如果为`false` ，则不查询用户的自定义数据，并且`context.user.custom_data`为空对象。
`create_user_on_auth` `boolean`	如果`true` ，如果提供的用户档案成功进行身份验证，您的应用程序会自动创建一个新用户，但未与现有用户关联。此设置对于通过自定义 JSON web token 身份验证提供者与外部身份验证系统集成的应用程序非常有用。如果一个请求包含来自外部系统的与注册用户不对应的有效 JSON web token，则会创建一个以 JSON web token 作为身份的新用户。
`disabled` `boolean`	启用 ( `false` ) 或禁用 ( `true` ) 端点。

数据 API 配置

在https_endpoints/data_api_config.json中为应用程序生成的数据API 端点定义配置。

{
  "disabled": <boolean>,
  "versions": ["v1"],
  "return_type": "EJSON" | "JSON",
  "create_user_on_auth": <boolean>,
  "run_as_system": <boolean>,
  "run_as_user_id": "<User Account ID>",
  "run_as_user_id_script_source": "<Function Source Code>"
}

字段	说明
`disabled` `boolean`	如果为`false`，则未启用数据API。生成的端点不会处理或响应请求。
`versions` `string[]`	您的应用支持的数据API版本的列表。该列表可能包括所有可能版本的子集，但必须按升序列出版本。您无法启用最新版本以外的版本，但此处列出的任何以前启用的版本都将继续有效。可用版本： `"v1"`
`return_type` `string`	用于 HTTPS 响应正文中端点返回的数据的数据格式。以下之一： `"EJSON"` `"JSON"`
`create_user_on_auth` `boolean`	如果`true` ，如果提供的用户档案成功进行身份验证，您的应用程序会自动创建一个新用户，但未与现有用户关联。此设置对于通过自定义 JSON web token 身份验证提供者与外部身份验证系统集成的应用程序非常有用。如果一个请求包含来自外部系统的与注册用户不对应的有效 JSON web token，则会创建一个以 JSON web token 作为身份的新用户。
`run_as_user_id` `string`	应用程序用户的帐号 ID。如果已定义，端点将始终以指定的用户身份运行。不能与 `run_as_user_id_script_source` 一起使用。
`run_as_user_id_script_source` `string`	返回应用程序用户帐户 ID 的函数的字符串化源代码。如果已定义，端点将在每个请求时执行该函数，并以具有该函数返回的 ID 的用户身份运行。不能与 `run_as_user_id` 一起使用。

后退

静态托管

来年

日志转发器