Descarga la configuración actual de la aplicación. Puedes descargarla en dos formatos diferentes:
Un archivo zip comprimido que contiene el directorio de archivos de configuración. Esto es más útil cuando trabajas con la CLI, un sistema de control de versiones o en otro entorno basado en el sistema de archivos.
Un único objeto JSON que contiene toda la configuración. Esto resulta especialmente útil al trabajar con la API u otro entorno que pueda analizar JSON.
Puede especificar qué formato desea descargar configurando el encabezado Accept.
Parámetros de ruta
-
Un ID de proyecto/grupo Atlas.
-
El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.
Respuestas
-
Tirar con éxito
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
-
El nombre de la aplicación.
región_del_proveedor
string Requerido Uno de: Los valores son
aws-us-east-1,aws-us-west-2,aws-us-east-2,aws-eu-central-1,aws-eu-west-1,aws-eu-west-2,aws-ap-southeast-1,aws-ap-southeast-2,aws-ap-south-1oaws-sa-east-1.Los valores son
azure-eastus2,azure-westus,azure-westeurope,azure-eastasiaoazure-southeastasia.Los valores son
gcp-us-central1,gcp-us-east4,gcp-us-west1,gcp-europe-west1ogcp-asia-south1.-
Un modelo de implementación de aplicaciones.
Los valores son
GLOBALoLOCAL. -
El entorno de la aplicación.
Los valores son
development,testing,qaoproduction. -
Cualquiera de: Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación anónima, este valor siempre es
anon-user.El valor es
anon-user. -
El nombre del proveedor de autenticación. Para la autenticación anónima, este valor siempre es
anon-user.El valor es
anon-user. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación por correo electrónico y contraseña, este valor siempre es
local-userpass.El valor es
local-userpass. -
El nombre del proveedor de autenticación. Para la autenticación por correo electrónico y contraseña, este valor siempre es
local-userpass.El valor es
local-userpass. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. config
Objeto Uno de: Ocultar atributos Mostrar atributos
-
Si es
true, confirmar automáticamente las nuevas cuentas de usuario sin verificación adicional.El valor es
true. -
La URL incluida en el correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado. El correo electrónico también añade un restablecimiento de contraseña único
tokenytokenIdcomo parámetros de consulta.Esta URL debe gestionar la confirmación del usuario pasando el token de restablecimiento de contraseña a una función
resetPassworddel SDK de Realm. -
La línea de asunto del correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado.
Ocultar atributos Mostrar atributos
-
Si es
true, confirmar automáticamente las nuevas cuentas de usuario sin verificación adicional.El valor es
true. -
Si es
true, utilice una función personalizada que defina para manejar el proceso de restablecimiento de contraseña.El valor es
true. -
El nombre de la función personalizada que maneja el proceso de restablecimiento de contraseña.
Ocultar atributos Mostrar atributos
-
Si es
true, se confirman automáticamente las nuevas cuentas de usuario sin verificación adicional. Para la confirmación de la cuenta de correo electrónico integrada, configure este valor enfalse.El valor es
false. -
La URL incluida en el correo electrónico enviado a los nuevos usuarios como parte del flujo de confirmación integrado. El correo electrónico también añade una confirmación única
tokenytokenIdcomo parámetros de consulta.Esta URL debe gestionar la confirmación del usuario pasando el token de confirmación a una función del SDK de Realm
confirmUsero al punto final Confirmar un usuario con correo electrónico/contraseña pendiente de la API de administración. -
La línea de asunto del correo electrónico enviado a nuevos usuarios como parte del flujo de confirmación integrado.
-
La URL incluida en el correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado. El correo electrónico también añade un restablecimiento de contraseña único
tokenytokenIdcomo parámetros de consulta.Esta URL debe gestionar la confirmación del usuario pasando el token de restablecimiento de contraseña a una función
resetPassworddel SDK de Realm. -
La línea de asunto del correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado.
Ocultar atributos Mostrar atributos
-
Si es
true, se confirman automáticamente las nuevas cuentas de usuario sin verificación adicional. Para la confirmación de la cuenta de correo electrónico integrada, configure este valor enfalse.El valor es
false. -
La URL incluida en el correo electrónico enviado a los nuevos usuarios como parte del flujo de confirmación integrado. El correo electrónico también añade una confirmación única
tokenytokenIdcomo parámetros de consulta.Esta URL debe gestionar la confirmación del usuario pasando el token de confirmación a una función del SDK de Realm
confirmUsero al punto final Confirmar un usuario con correo electrónico/contraseña pendiente de la API de administración. -
La línea de asunto del correo electrónico enviado a nuevos usuarios como parte del flujo de confirmación integrado.
-
Si es
true, utilice una función personalizada que defina para manejar el proceso de restablecimiento de contraseña.El valor es
true. -
El nombre de la función personalizada que maneja el proceso de restablecimiento de contraseña.
Ocultar atributos Mostrar atributos
-
Si es
true, se confirman automáticamente las nuevas cuentas de usuario sin verificación adicional. Para la confirmación de cuentas con funciones personalizadas, configure este valor enfalse.El valor es
false. -
Si es
true, los nuevos registros de cuentas de usuario de correo electrónico/contraseña utilizan una función personalizada que usted define para manejar el proceso de confirmación. -
El nombre de la función personalizada que maneja el proceso de confirmación.
-
La URL incluida en el correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado. El correo electrónico también añade un restablecimiento de contraseña único
tokenytokenIdcomo parámetros de consulta.Esta URL debe gestionar la confirmación del usuario pasando el token de restablecimiento de contraseña a una función
resetPassworddel SDK de Realm. -
La línea de asunto del correo electrónico enviado a los usuarios como parte del flujo de restablecimiento de contraseña integrado.
Ocultar atributos Mostrar atributos
-
Si es
true, se confirman automáticamente las nuevas cuentas de usuario sin verificación adicional. Para la confirmación de cuentas con funciones personalizadas, configure este valor enfalse.El valor es
false. -
Si es
true, los nuevos registros de cuentas de usuario de correo electrónico/contraseña utilizan una función personalizada que usted define para manejar el proceso de confirmación. -
El nombre de la función personalizada que maneja el proceso de confirmación.
-
Si es
true, utilice una función personalizada que defina para manejar el proceso de restablecimiento de contraseña.El valor es
true. -
El nombre de la función personalizada que maneja el proceso de restablecimiento de contraseña.
-
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación con clave API, este valor siempre es
api-key.El valor es
api-key. -
El nombre del proveedor de autenticación. Para la autenticación con clave API, este valor siempre es
api-key.El valor es
api-key. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación JWT personalizada, este valor siempre es
custom-token.El valor es
custom-token. -
El nombre del proveedor de autenticación. Para la autenticación JWT personalizada, este valor siempre es
custom-token.El valor es
custom-token. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. -
Un objeto de configuración para el proveedor de autenticación JWT personalizado.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Define los valores esperados de la reclamación
auden el JWT externo. De forma predeterminada, el proveedor de JWT personalizado espera queaudsea el ID de la aplicación. -
Si
falsees, el JWT externo debe incluir todos los valores definidos enaudienceen suaudreclamo.Si
truees, un JWT es válido si alguno de los valores definidos enaudienceestá en suaudreclamo.El valor predeterminado es
false. -
El método criptográfico que utiliza el sistema externo para firmar el JWT. La autenticación JWT personalizada admite JWT firmados con cualquiera de los siguientes algoritmos:
- HS256
- RS256
-
Si
truees, el proveedor JWT personalizado utiliza un algoritmo de firma y claves de firma definidas en una clave web JSON (JWK) o un conjunto de claves web JSON (JWKS). Las JWK deben ser accesibles en la URL especificadajwkURIen. -
Una URL que aloja un JWK o JWKS y describe el método de firma y las claves de firma que debe usar el proveedor JWT personalizado. Los JWK pueden especificar hasta tres claves de firma y deben usar el algoritmo RS256.
-
-
Ocultar el atributo secret_config Mostrar el atributo secret_config Objeto
-
Los campos de metadatos son datos adicionales que describen a cada usuario. El valor de cada campo de metadatos proviene de algún campo incluido en el JWT del sistema de autenticación externo.
Los campos de metadatos de un usuario se actualizan cada vez que inicia sesión.
Un campo de metadatos específico del JWT externo para incluir los datos del usuario. Esto asigna un nombre de campo JWT externo (
name) al nombre del campo en los datos del usuario (field_name) que contiene el valor de ese campo.Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
-
Si es
true, este valor siempre debe estar presente en el JWT externo. -
El nombre del campo en el JWT externo que contiene los datos.
Para especificar un campo en un objeto incrustado, utilice la notación de puntos.
-
El nombre del campo en el objeto Usuario que contiene el valor.
-
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación con función personalizada, este valor siempre es
custom-function.El valor es
custom-function. -
El nombre del proveedor de autenticación. Para la autenticación con función personalizada, este valor siempre es
custom-function.El valor es
custom-function. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. -
Un objeto de configuración para el proveedor de autenticación de función personalizada.
Ocultar atributo de configuración Mostrar atributo de configuración Objeto
-
El nombre de la función de autenticación personalizada que maneja los inicios de sesión de los usuarios.
-
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación de Apple, este valor siempre es
oauth2-apple.El valor es
oauth2-apple. -
El nombre del proveedor de autenticación. Para la autenticación de Apple, este valor siempre es
oauth2-apple.El valor es
oauth2-apple. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. -
Un objeto de configuración para el proveedor de autenticación de Apple.
Ocultar atributo de configuración Mostrar atributo de configuración Objeto
-
Su ID de servicios de Apple.
Para aprender cómo obtener esto, consulta Crear un ID de Servicios.
-
-
Ocultar el atributo secret_config Mostrar el atributo secret_config Objeto
-
El nombre de un Secreto que contiene tu secreto JWT de cliente.
Para aprender cómo crear esto,consulte Crear el JWT secreto de cliente.
-
-
Una lista de URI a las que el flujo OAuth debería permitir redirigir al usuario.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación de Google, este valor siempre es
oauth2-google.El valor es
oauth2-google. -
El nombre del proveedor de autenticación. Para la autenticación de Google, este valor siempre es
oauth2-google.El valor es
oauth2-google. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. -
Un objeto de configuración para el proveedor de autenticación de Google.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Un ID de cliente OAuth 2.0 para su proyecto de GCP.
Para aprender a crear uno, consulta Configurar un proyecto en la Consola de API de Google.
-
An OAuth 2.0
-
-
Ocultar el atributo secret_config Mostrar el atributo secret_config Objeto
-
El nombre de un secreto que contiene el secreto de cliente OAuth 2.0 para el ID de cliente especificado
config.clientIden.
-
-
Una lista de URI a las que el flujo OAuth debería permitir redirigir al usuario.
-
Los campos de metadatos son datos adicionales que describen a cada usuario. El valor de cada campo de metadatos proviene de Google y se incluye en el JWT autenticado.
Los campos de metadatos de un usuario se actualizan cada vez que inicia sesión.
Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
-
Una lista de nombres de dominio aprobados para cuentas de usuario. Si se define, el usuario debe tener una dirección de correo electrónico asociada a su perfil de OAuth que tenga un dominio incluido en esta lista.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación de Facebook, este valor siempre es
oauth2-facebook.El valor es
oauth2-facebook. -
El nombre del proveedor de autenticación. Para la autenticación de Facebook, este valor siempre es
oauth2-facebook.El valor es
oauth2-facebook. -
Si es
true, el proveedor de autenticación está deshabilitado. Los usuarios no pueden iniciar sesión a través del proveedor hasta que esté habilitado. -
Un objeto de configuración para el proveedor de autenticación de Facebook.
-
Ocultar el atributo secret_config Mostrar el atributo secret_config Objeto
-
El nombre de un secreto que contiene el secreto de tu aplicación de Facebook.
-
-
Una lista de URI a las que el flujo OAuth debería permitir redirigir al usuario.
-
Los campos de metadatos son datos adicionales que describen a cada usuario. El valor de cada campo de metadatos proviene de Facebook y se incluye en el JWT autenticado.
Los campos de metadatos de un usuario se actualizan cada vez que inicia sesión.
Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
-
Una lista de nombres de dominio aprobados para cuentas de usuario. Si se define, el usuario debe tener una dirección de correo electrónico asociada a su perfil de OAuth que tenga un dominio incluido en esta lista.
-
-
Ocultar los atributos custom_user_data Mostrar atributos custom_user_data objeto | nulo
-
El nombre de la base de datos que contiene datos de usuario personalizados.
-
El nombre de la colección que contiene datos de usuario personalizados.
-
El nombre de un campo que aparece en cada documento de datos de usuario personalizado y que contiene el ID de la cuenta de usuario del usuario correspondiente de cada documento.
-
Si es
true, se habilitan los datos de usuario personalizados. -
El nombre de la fuente de datos MongoDB vinculada que contiene datos de usuario personalizados.
-
El nombre de una función de creación de usuarios que se ejecuta cada vez que se registra un nuevo usuario.
-
-
Ocultar atributos data_api_config Mostrar atributos data_api_config objeto | nulo
-
Una versión compatible de la API de datos.
El valor es
v1. -
Un formato de datos compatible con la API de datos y puntos finales personalizados.
Los valores son
JSONoEJSON. -
ID de cuenta de un usuario de la aplicación. Si se define, los endpoints siempre se ejecutarán con el usuario especificado.
-
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.
-
Los valores son
NO_VALIDATION,SECRET_AS_QUERY_PARAMoVERIFY_PAYLOAD. -
Si
validation_methodestá establecido en"SECRET_AS_QUERY_PARAM"o"VERIFY_PAYLOAD", este es elnamedel Secreto que autoriza las solicitudes. -
Una expresión JSON que evalúa como
truesi se permite que un punto final se ejecute en respuesta a una solicitud entrante.
-
Uno de: Ocultar atributos Mostrar atributos
-
El nombre del servicio.
-
El tipo de servicio.
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El nombre del clúster de la fuente de datos. El nombre puede tener como máximo 64 caracteres y solo debe contener letras ASCII, números, guiones bajos y guiones.
-
El modo de preferencia de lectura para solicitudes de lectura a la fuente de datos.
Los valores son
primary,primaryPreferred,secondary,secondaryPreferredonearest. -
Dirija las operaciones de lectura a miembros específicos de un conjunto de réplicas.
Los valores son
server1oserver2. -
Si es verdadero, los clientes pueden conectarse a la aplicación a través del protocolo MongoDB Wire [obsoleto].
-
-
Una regla de acceso a datos que define roles de usuario de respaldo y filtros de consulta para colecciones que no tienen permisos más específicos definidos.
Ocultar atributos de default_rule Mostrar atributos de la regla predeterminada Objeto
-
Una lista ordenada de roles de usuario predeterminados.
Ocultar atributos de roles Mostrar atributos de roles Objeto
-
Ocultar atributos de document_filters Mostrar atributos de document_filters Objeto
-
El nombre del rol.
-
Un objeto que asigna nombres de campos de documento a permisos de lectura y escritura para el campo y sus hijos.
-
Permisos de lectura y escritura para un campo.
Ocultar atributos de campos adicionales Mostrar atributos de campos adicionales Objeto
-
-
Una lista de filtros de consulta predeterminados.
Un filtro que modifica condicionalmente las operaciones de consulta entrantes antes de que se ejecuten.
Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
-
El nombre del filtro.
-
Un objeto de consulta MongoDB.
-
Un objeto de proyección MongoDB.
-
-
-
Una regla de acceso a datos que define roles de usuario y filtros de consulta para una colección en una fuente de datos vinculada.
Ocultar atributos de reglas Mostrar atributos de normativas Objeto
-
El nombre de una base de datos en la fuente de datos vinculada.
-
El nombre de una colección en el
databaseespecificado. -
Una lista de roles de acceso a datos.
Ocultar atributos de roles Mostrar atributos de roles Objeto
-
Ocultar atributos de document_filters Mostrar atributos de document_filters Objeto
-
El nombre del rol.
-
Un objeto que asigna nombres de campos de documento a permisos de lectura y escritura para el campo y sus hijos.
-
Permisos de lectura y escritura para un campo.
Ocultar atributos de campos adicionales Mostrar atributos de campos adicionales Objeto
-
-
Una lista de filtros para operaciones entrantes.
Un filtro que modifica condicionalmente las operaciones de consulta entrantes antes de que se ejecuten.
Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
-
El nombre del filtro.
-
Un objeto de consulta MongoDB.
-
Un objeto de proyección MongoDB.
-
-
Ocultar atributos Mostrar atributos
-
El valor es
mongodb-datafederation. -
El valor es
datalake. -
Ocultar atributo de configuración Mostrar atributo de configuración Objeto
-
-
Ocultar atributos de puntos finales Mostrar atributos de puntos finales Objeto
-
Los valores son
GET,POST,PUT,PATCH,DELETEo*. -
Los valores son
NO_VALIDATION,SECRET_AS_QUERY_PARAMoVERIFY_PAYLOAD. -
Si
validation_methodestá establecido en"SECRET_AS_QUERY_PARAM"o"VERIFY_PAYLOAD", este es el_iddel Secreto que autoriza las solicitudes. -
Un formato de datos compatible con la API de datos y puntos finales personalizados.
Los valores son
JSONoEJSON. -
Nombre de la función del punto final.
-
Ocultar atributos de entornos Mostrar atributos de entornos Objeto
-
Un objeto que asigna cada nombre de entorno posible a las definiciones de los valores de entorno disponibles en ese entorno.
Hide values attributes Mostrar atributos de valores Objeto
-
-
Ocultar atributos de funciones Mostrar atributos de funciones Objeto
-
Una expresión JSON que evalúa como
truesi se permite que la función se ejecute en respuesta a una solicitud entrante. -
Un nombre único para la función.
-
Si es
true, la función se oculta a las aplicaciones cliente. Aún se puede llamar a una función privada desde expresiones JSON y otras funciones, incluyendo webhooks y activadores entrantes. -
El código fuente de la función, convertido en cadena. El código debe ser ES6 válido.
-
Si es
true, la función se ejecuta con privilegios completos, omitiendo las reglas de todos los servicios. -
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. -
El código fuente en cadena de una función que devuelve el ID de la cuenta de un usuario de la aplicación. Si se define, los puntos finales 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
run_as_user_idcon.
-
-
Ocultar atributos graphql Mostrar atributos graphql Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Si es
true, los nombres de tipos de esquema generados utilizan la pluralización inglesa común siempre que sea posible.Si
false, o si no se puede determinar una pluralización natural, entonces los tipos plurales usan el nombre del tipo singular con una"s"añadida al final.No puedes cambiar este valor después de crear tu aplicación. Este valor es
truepara todas las aplicaciones nuevas. -
Si
true, la API de GraphQL bloquea consultas de introspección de clientes.
-
-
Ocultar los atributos validation_settings Mostrar atributos de validation_settings Objeto
-
Ocultar atributos de custom_resolvers Mostrar atributos custom_resolvers Objeto
-
El nombre del tipo principal del solucionador. Puede ser
"Query","Mutation"o el nombre de un tipo generado si se trata de una propiedad calculada. -
El nombre del campo de resolución personalizado que aparece en el esquema GraphQL.
-
El tipo de entrada que utiliza el resolvedor personalizado. Este valor debe corresponder al valor de
input_type:- Un tipo de entrada escalar debe utilizar
"scalar"o"scalar-list" - Un tipo de entrada generado debe utilizar
"generated"o"generated-list" - Se debe utilizar un tipo de entrada personalizado
"custom"
Si no está definido, el solucionador no acepta ninguna entrada.
Los valores son
scalar,scalar-list,generated,generated-listocustom. - Un tipo de entrada escalar debe utilizar
tipo de carga útil
string | objeto El tipo del valor devuelto por el resolvedor personalizado. Puede ser un escalar, el nombre de un tipo generado existente o un objeto de esquema JSON personalizado.
Si no está definido, el solucionador devuelve un objeto
DefaultPayload:type DefaultPayload { status: String! }-
El tipo de carga útil que utiliza el resolvedor personalizado. Este valor debe corresponder al valor de
payload_type:- Un tipo de carga útil escalar debe utilizar
"scalar"o"scalar-list" - Un tipo de carga útil generada debe utilizar
"generated"o"generated-list" - Se debe utilizar un tipo de carga útil personalizado
"custom"
Si no está definido, el solucionador devuelve un objeto
DefaultPayload.Los valores son
scalar,scalar-list,generated,generated-listocustom. - Un tipo de carga útil escalar debe utilizar
-
Nombre de la función de resolución.
-
-
-
[Obsoleto] Lista de servicios HTTP heredados. Esto es solo por compatibilidad con versiones anteriores.
Ocultar atributos https_endpoints Mostrar atributos https_endpoints Objeto
-
El nombre del servicio.
-
El tipo de servicio.
Los valores son
aws,twilio,github,gcmohttp. -
Ocultar atributos incoming_webhooks Mostrar los atributos incoming_webhooks Objeto
-
-
Ocultar atributos de log_forwarders Mostrar atributos de log_forwarders Objeto
-
Los valores son
auth,endpoint,function,graphql,push,schema,service,sync,triggerotrigger_error_handler. -
Los valores son
errorosuccess.
-
Ocultar atributos de esquemas Mostrar atributos de esquemas Objeto
-
Metadatos que describen a qué colección vinculada se aplica el esquema.
-
Un esquema válido para la colección.
Ocultar atributos del esquema Mostrar atributos del esquema Objeto
-
El tipo BSON del campo.
Los valores son
object,array,string,number,int,long,double,decimal,date,timestamp,bool,null,regex,objectId,binary,uuid,function,javascript,symbol,minKeyomaxKey. -
Un título legible para humanos para el esquema.
-
Para los esquemas
object, una matriz de nombres de campos que se requieren en las instancias del objeto. -
Un objeto donde cada nombre de campo es una propiedad del esquema. El valor correspondiente es una definición de esquema para ese campo.
Ocultar atributo de propiedades Mostrar atributo de propiedades Objeto
-
Un esquema válido para la colección.
-
-
-
Relaciones con colecciones externas. Cada nombre de campo es una propiedad del esquema. El valor correspondiente es una definición de relación para ese campo.
Ocultar el atributo de relaciones Mostrar atributo de relaciones Objeto
-
Ocultar * atributos Mostrar * atributos Objeto
-
Una cadena de referencia para la colección extranjera.
-
El nombre del campo en la colección externa al que apunta la relación.
-
Si
true:- La relación puede apuntar a muchos documentos extranjeros.
- El campo local debe definirse como una matriz en el esquema de colección.
-
-
-
-
[Obsoleto] Lista de servicios heredados de terceros no HTTP. Esto es solo por compatibilidad con versiones anteriores.
Ocultar atributos de servicios Mostrar atributos de servicios Objeto
-
El nombre del servicio.
-
El tipo de servicio.
Los valores son
aws,twilio,github,gcmohttp. -
Ocultar atributos incoming_webhooks Mostrar los atributos incoming_webhooks Objeto
-
-
Ocultar atributos de sincronización Mostrar atributos de sincronización Objeto
-
El estado del servicio de sincronización (
"enabled","disabled"o vacío si la sincronización no está configurada). -
El nombre de una base de datos en el clúster sincronizado donde App Services almacena datos en modo de desarrollo. App Services genera automáticamente un esquema para cada tipo sincronizado y asigna cada tipo de objeto a una colección dentro de la base de datos.
-
Una matriz de nombres de campos consultables en cualquier colección.
-
Una lista de nombres de campos para usar como campo indexado consultable. Aunque esta propiedad es un arreglo, Sincronización actualmente soporta solo un campo indexado consultable. Por lo tanto, este arreglo puede contener como máximo un elemento.
El campo consultable indexado debe estar presente en el esquema y ser del mismo tipo de campo elegible en todas las colecciones que sincronices. El nombre del campo indexado consultable también debe aparecer en
queryable_fields_namesya que este es un campo consultable global. -
Una matriz de nombres de campos consultables en la colección especificada.
-
Obsoleto
-
La última vez que se deshabilitó la sincronización, representada por la cantidad de segundos desde la época de UNIX.
-
Especifica si el modo de restablecimiento del cliente está deshabilitado. De forma predeterminada, el modo de restablecimiento del cliente está habilitado y este valor es
false. -
Una matriz de nombres de colecciones que se definen como asimétricas con la ingesta de datos, donde los clientes pueden escribir datos pero no leerlos.
-
-
Uno de: Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores de base de datos, este valor siempre es
"DATABASE".El valor es
DATABASE. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El valor
_idde una fuente de datos MongoDB vinculada que contiene la colección observada.Puede enumerar servicios con el punto final Obtener todos los servicios.
Las fuentes de datos son servicios cuyo valor
typees "mongodb-atlas". Use el valor_idpara la fuente de datos que desea vincular al disparador. -
El nombre de una base de datos en la fuente de datos vinculada. Si omite este parámetro, el tipo de origen cambia a "Implementación". Sin embargo, la infraestructura de nivel compartido no admite flujos de cambios de implementación. Si omite el parámetro "database", recibirá el error "Los flujos de cambios de implementación no son compatibles con los clústeres de nivel compartido". Proporcione el parámetro "database" para resolver este error.
-
El nombre de una colección en la base de datos especificada. El disparador escucha eventos de esta colección. Si se omite este parámetro, el tipo de origen cambia a "Base de datos".
-
Los tipos de eventos de cambio de MongoDB que el disparador escucha.
Los tipos de operación válidos para todos los activadores incluyen:
"INSERT""UPDATE""REPLACE""DELETE"
Los tipos de operaciones válidos adicionales para desencadenadores de bases de datos e implementación incluyen:
"CREATE_COLLECTION""MODIFY_COLLECTION""RENAME_COLLECTION""DROP_COLLECTION""SHARD_COLLECTION""RESHARD_COLLECTION""REFINE_COLLECTION_SHARD_KEY"
Los tipos de operaciones válidos adicionales para los activadores de implementación incluyen:
"DROP_DATABASE"
Para más información, consulta Configuración de activadores.
Al menos
1elemento. -
Una expresión $match filtra eventos de cambio. El disparador solo se activará si la expresión se evalúa como verdadera para un evento de cambio determinado.
-
Una expresión $project devuelve solo los campos especificados. Puede incluir o excluir campos específicos, o incluir campos recién calculados.
-
Si
truees, indica queUPDATEeventos de cambio deben incluir la versión más actual y mayoritariamente comprometida del documento modificado en elfullDocumentcampo.El valor predeterminado es
false. -
Si es verdadero, indica que
UPDATEeventos de cambio deben incluir una instantánea del documento modificado inmediatamente antes de que se aplicara la actualización.Debe habilitar las preimágenes de documentos para su clúster para incluir estas instantáneas.
El valor predeterminado es
false. -
Si es
true, habilitar el disparador después de haberlo deshabilitado no invocará eventos que ocurrieron mientras el disparador estaba deshabilitado.El valor predeterminado es
false. -
Si
true, cuando no se encuentra el token de reanudación de este disparador en el registro de operaciones del clúster, este reanuda automáticamente el procesamiento de eventos en el siguiente evento relevante del flujo de cambios. Todos los eventos del flujo de cambios desde que se suspendió el disparador hasta que este reanude su ejecución no se activan.El valor predeterminado es
false. -
Si
truees, el disparador utilizará la opción de maximizar el rendimiento.El valor predeterminado es
false. -
Si es
true, la ordenación de eventos está deshabilitada y este disparador puede procesar eventos en paralelo. Si esfalse, la ordenación de eventos está habilitada y el disparador ejecuta eventos en serie.El valor predeterminado es
false.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
-
Un objeto que define la gestión de errores personalizada para un disparador de AWS EventBridge. Válido solo para disparadores de tipo
"DATABASE"con procesadores de eventos"AWS_EVENTBRIDGE".Ocultar el atributo error_handler Mostrar el atributo error_handler Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores de autenticación, este valor siempre es
"AUTHENTICATION".El valor es
AUTHENTICATION. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El tipo de evento de autenticación que el disparador escucha.
Los valores son
LOGIN,CREATEoDELETE. -
El tipo(s) de proveedor de autenticación que escucha el disparador.
Los valores son
anon-user,api-key,custom-token,custom-function,local-userpass,oauth2-apple,oauth2-facebookooauth2-google.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
El tipo de disparador. Para los disparadores programados, este valor siempre es
"SCHEDULED".El valor es
SCHEDULED. -
Si es
true, el disparador está deshabilitado y no escucha eventos ni se ejecuta.El valor predeterminado es
false. -
Un objeto que define valores de configuración para el disparador.
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
Una expresión cron que especifica cuándo se ejecuta el disparador.
-
Si es
true, habilitar el disparador después de haberlo deshabilitado no invocará eventos que ocurrieron mientras el disparador estaba deshabilitado.
-
-
El ID de la función que el disparador llama cuando se activa.
Este valor es igual a
event_processors.FUNCTION.function_id. Puede definirlo aquí o enevent_processors.FUNCTION.function_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es igual a
event_processors.FUNCTION.function_name. Puede definirlo aquí o enevent_processors.FUNCTION.function_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador. -
Un objeto donde cada nombre de campo es un ID de procesador de eventos y cada valor es un objeto que configura su procesador de eventos correspondiente. Para ver un ejemplo de objeto de configuración, consulte Enviar eventos de activación a AWS EventBridge.
Ocultar atributos de event_processors Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Mostrar atributos de configuración Objeto
-
El ID de la función que el disparador llama cuando se activa.
Este valor es el mismo que el
function_idde nivel raíz. Puede definirlo aquí o enfunction_id. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.Si define
function_id,event_processorsno es obligatorio. Debe proporcionarfunction_idoevent_processorsal actualizar un disparador. -
El nombre de la función que el disparador llama cuando se activa, es decir, la función descrita por
function_id.Este valor es el mismo que el
function_namede nivel raíz. Puede definirlo aquí o enfunction_name. El backend de App Services duplica el valor en la ubicación de configuración donde no lo definió.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.Si define
function_name,event_processorsno es obligatorio. Debe proporcionarfunction_nameoevent_processorsal actualizar un disparador.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Mostrar el atributo AWS_EVENTBRIDGE Objeto
-
-
Un archivo zip que contiene el directorio del archivo de configuración de la aplicación
-
-
Invalid request
-
Error al extraer la configuración
curl \
--request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/pull' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"name": "string",
"provider_region": "aws-us-east-1",
"deployment_model": "GLOBAL",
"environment": "production",
"auth_providers": [
{
"name": "anon-user",
"type": "anon-user",
"disabled": true
}
],
"custom_user_data": {
"database_name": "myapp",
"collection_name": "users",
"user_id_field": "user_account_id",
"enabled": true,
"mongo_service_name": "mongodb-atlas",
"on_user_creation_function_name": "myFunction"
},
"data_api_config": {
"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": {}
},
"data_sources": [
{
"name": "string",
"type": "string",
"config": {
"clusterName": "Cluster0",
"readPreference": "primary",
"readPreferenceTagSets": [
"server1"
],
"wireProtocolEnabled": true
},
"default_rule": {
"roles": [
{
"document_filters": {
"read": {},
"write": {}
},
"name": "string",
"apply_when": {},
"read": {},
"write": {},
"insert": {},
"delete": {},
"search": {},
"fields": {},
"additional_fields": {
"read": {},
"write": {}
}
}
],
"filters": [
{
"name": "string",
"apply_when": {},
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
},
"rules": [
{
"database": "string",
"collection": "string",
"roles": [
{
"document_filters": {
"read": {},
"write": {}
},
"name": "string",
"apply_when": {},
"read": {},
"write": {},
"insert": {},
"delete": {},
"search": {},
"fields": {},
"additional_fields": {
"read": {},
"write": {}
}
}
],
"filters": [
{
"name": "string",
"apply_when": {},
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
}
]
}
],
"endpoints": [
{
"route": "string",
"http_method": "GET",
"function_id": "string",
"validation_method": "NO_VALIDATION",
"secret_id": "string",
"return_type": "JSON",
"respond_result": true,
"fetch_custom_user_data": true,
"create_user_on_auth": true,
"disabled": true,
"function_name": "string"
}
],
"environments": {
"values": {
"none": {
"values": {}
},
"development": {
"values": {}
},
"testing": {
"values": {}
},
"qa": {
"values": {}
},
"production": {
"values": {}
}
}
},
"functions": [
{
"can_evaluate": {},
"name": "string",
"private": true,
"source": "string",
"run_as_system": true,
"run_as_user_id": "string",
"run_as_user_id_script_source": "string"
}
],
"graphql": {
"config": {
"use_natural_pluralization": true,
"disable_schema_introspection": true
},
"validation_settings": {
"read_validation_action": "ERROR",
"read_validation_level": "STRICT",
"write_validation_action": "ERROR",
"write_validation_level": "STRICT"
},
"custom_resolvers": [
{
"on_type": "string",
"field_name": "string",
"input_type": "string",
"input_type_format": "scalar",
"payload_type": "string",
"payload_type_format": "scalar",
"function_name": "string"
}
]
},
"hosting": {
"enabled": true,
"custom_domain": "example.com",
"default_error_path": "/404.html",
"default_error_code": "404"
},
"https_endpoints": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"log_forwarders": [
{
"name": "string",
"disabled": true,
"log_types": [
"auth"
],
"log_statuses": [
"error"
],
"policy": {
"type": "single"
},
"action": {
"type": "collection",
"name": "string",
"data_source": "string",
"database": "string",
"collection": "string"
}
}
],
"schemas": [
{
"metadata": {
"data_source": "string",
"database": "string",
"collection": "string"
},
"schema": {
"bsonType": "object",
"title": "string",
"required": [
"string"
],
"properties": {
"*": {}
}
},
"relationships": {
"additionalProperty1": {
"ref": "string",
"foreign_key": "string",
"is_list": true
},
"additionalProperty2": {
"ref": "string",
"foreign_key": "string",
"is_list": true
}
}
}
],
"services": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"sync": {
"state": "string",
"database_name": "string",
"queryable_fields_names": [
"string"
],
"indexed_queryable_fields_names": [
"string"
],
"collection_queryable_fields_names": {
"additionalProperty1": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"additionalProperty2": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"permissions": {},
"last_disabled": "string",
"client_max_offline_days": 42,
"is_recovery_mode_disabled": true,
"asymmetric_tables": [
"string"
]
},
"triggers": [
{
"name": "onNewEmployee",
"type": "DATABASE",
"config": {
"match": {},
"project": {},
"database": "HR",
"collection": "employees",
"service_id": "5adeb649b8b998486770ae7c",
"full_document": true,
"operation_types": [
"INSERT"
]
},
"function_id": "5eea9ca4ca0e356e2c2a148a",
"event_processors": {
"FUNCTION": {
"config": {
"function_id": "6841b8d3e71dc81bed89dbba",
"function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
}
}
}
}
],
"values": [
{
"name": "string",
"private": true,
"from_secret": true
}
]
}