Archivos de configuración de puntos finales HTTPS

Atlas App Services ha llegado al final de su ciclo de vida y MongoDB ya no ofrece soporte activo. Los activadores siguen disponibles en la interfaz de usuario de Atlas. Consulte Página de desuso para más detalles.

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

Configuración personalizada de punto final HTTPS

Define las configuraciones para todos los puntos finales HTTPS personalizados de tu aplicación como una matriz en https_endpoints/config.json.

[
  {
    "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>
  }
]

Campo	Descripción
`route` `string`	La ruta del punto final.
`http_method` `string`	El tipo de Método HTTPque gestiona el punto final. Especifique `` para gestionar todos los métodos con un único punto final. Uno de: `"GET"` `"POST"` `"PUT"` `"PATCH"` `"DELETE"` `"DELETE"` `""`
`function_name` `string`	El nombre de la función asociada al punto final. La función debe usar la firma de la función del punto final.
`validation_method` `string`	El esquema de autorización de punto final utilizado para validar las solicitudes entrantes. Uno de: `"SECRET_AS_QUERY_PARAM"` `"VERIFY_PAYLOAD"` `"NO_VALIDATION"`
`secret_name` `string`	El nombre de un secreto que contiene una cadena. Si `validation_method` se establece `SECRET_AS_QUERY_PARAM` en `VERIFY_PAYLOAD` o, este secreto se utiliza para autorizar solicitudes.
`respond_result` `boolean`	Si `true` es, el punto final devuelve una respuesta HTTP personalizable al cliente. La respuesta se configura llamando a los métodos del objeto Respuesta. Si no se configura, el punto final devuelve una `200 - Ok` respuesta con el valor devuelto por la función endpont como cuerpo de la solicitud. Si es `false`, las solicitudes devuelven una respuesta `204 - No Content` sin datos en el cuerpo.
`fetch_custom_user_data` `boolean`	Si `true` es, el documento de datos de usuario personalizado del usuario autenticado está disponible a través `context.user.custom_data` de. Si es `false`, no se consultan los datos personalizados del usuario y `context.user.custom_data` es un objeto vacío.
`create_user_on_auth` `boolean`	Si es `true`, su aplicación crea automáticamente un nuevo usuario si las credenciales de usuario proporcionadas se autentican correctamente pero no están asociadas con un usuario existente. Esta configuración es útil para aplicaciones que se integran con un sistema de autenticación externo mediante el proveedor de autenticación JWT personalizado. Si una solicitud incluye un JWT válido del sistema externo que no corresponde a un usuario registrado, esto crea un nuevo usuario con el JWT como una identidad.
`disabled` `boolean`	Habilita (`false`) o deshabilita (`true`) el punto final.

Configuración de la API de datos

Define la configuración para los puntos finales de API de datos generados por tu aplicación https_endpoints/data_api_config.json en.

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

Campo	Descripción
`disabled` `boolean`	Si es `false`, la API de datos no está habilitada. Los puntos de conexión generados no gestionarán ni responderán a las solicitudes.
`versions` `string[]`	Una lista de las versiones de la API de datos compatibles con tu aplicación. La lista puede incluir un subconjunto de todas las versiones posibles, pero debe estar en orden ascendente. No puedes habilitar una versión que no sea la más reciente, pero las versiones previamente habilitadas que se indican aquí seguirán funcionando. Versiones disponibles: `"v1"`
`return_type` `string`	El formato de datos que se utilizará para los datos devueltos por los puntos finales en los cuerpos de respuesta HTTPS. Uno de: `"EJSON"` `"JSON"`
`create_user_on_auth` `boolean`	Si es `true`, su aplicación crea automáticamente un nuevo usuario si las credenciales de usuario proporcionadas se autentican correctamente pero no están asociadas con un usuario existente. Esta configuración es útil para aplicaciones que se integran con un sistema de autenticación externo mediante el proveedor de autenticación JWT personalizado. Si una solicitud incluye un JWT válido del sistema externo que no corresponde a un usuario registrado, esto crea un nuevo usuario con el JWT como una identidad.
`run_as_user_id` `string`	ID de cuenta de un usuario de la aplicación. Si se define, los endpoints siempre se ejecutarán con el usuario especificado. No se puede usar con `run_as_user_id_script_source`.
`run_as_user_id_script_source` `string`	Código fuente en cadena para una función que devuelve el ID de la cuenta de un usuario de la aplicación. Si se define, los endpoints ejecutan la función en cada solicitud y se ejecutan como el usuario con el ID devuelto por la función. No se puede usar con `run_as_user_id`.

Volver

Alojamiento estático

Reenvíos de registros