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 solo objeto JSON que contiene toda la configuración. Esto es más útil cuando se trabaja con la API u otro entorno que puede parsear JSON.
You specify which format to download by setting the Accept header.
Parámetros de path
-
An Atlas Project/Group ID.
-
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.
provider_region
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.-
An application deployment model.
Los valores son
GLOBALoLOCAL. -
The application's environment.
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 es siempre
anon-user.El valor es
anon-user. -
El nombre del proveedor de autenticación. Para la autenticación anónima, este valor es siempre
anon-user.El valor es
anon-user. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación por correo electrónico/contraseña, este valor es siempre
local-userpass.El valor es
local-userpass. -
El nombre del proveedor de autenticación. Para la autenticación por correo electrónico/contraseña, este valor es siempre
local-userpass.El valor es
local-userpass. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. config
Objeto Uno de: Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification.El valor es
true. -
The URL included in the email sent to users as part of the built-in password reset flow. The email also adds a unique password reset
tokenandtokenIdas query parameters.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. -
The subject line of the email sent to users as part of the built-in password reset flow.
Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification.El valor es
true. -
Si
true, usa una función personalizada que definas para gestionar el proceso de restablecimiento de contraseña.El valor es
true. -
The name of the custom function that handles the password reset process.
Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification. For built-in email account confirmation, set this value tofalse.El valor es
false. -
The URL included in the email sent to new users as part of the built-in confirmation flow. The email also adds a unique confirmation
tokenandtokenIdas query parameters.Esta URL debe gestionar la confirmación del usuario pasando el token de confirmación a la función
confirmUserdel SDK de Realm o al endpoint de la API de administración Confirmar un usuario pendiente de correo electrónico/contraseña. -
The subject line of the email sent to new users as part of the built-in confirmation flow.
-
The URL included in the email sent to users as part of the built-in password reset flow. The email also adds a unique password reset
tokenandtokenIdas query parameters.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. -
The subject line of the email sent to users as part of the built-in password reset flow.
Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification. For built-in email account confirmation, set this value tofalse.El valor es
false. -
The URL included in the email sent to new users as part of the built-in confirmation flow. The email also adds a unique confirmation
tokenandtokenIdas query parameters.Esta URL debe gestionar la confirmación del usuario pasando el token de confirmación a la función
confirmUserdel SDK de Realm o al endpoint de la API de administración Confirmar un usuario pendiente de correo electrónico/contraseña. -
The subject line of the email sent to new users as part of the built-in confirmation flow.
-
Si
true, usa una función personalizada que definas para gestionar el proceso de restablecimiento de contraseña.El valor es
true. -
The name of the custom function that handles the password reset process.
Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification. For custom function account confirmation, set this value tofalse.El valor es
false. -
If
true, new email/password user account registrations use a custom function that you define to handle the confirmation process. -
The name of the custom function that handles the confirmation process.
-
The URL included in the email sent to users as part of the built-in password reset flow. The email also adds a unique password reset
tokenandtokenIdas query parameters.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. -
The subject line of the email sent to users as part of the built-in password reset flow.
Ocultar atributos Mostrar atributos
-
If
true, automatically confirm new user accounts without additional verification. For custom function account confirmation, set this value tofalse.El valor es
false. -
If
true, new email/password user account registrations use a custom function that you define to handle the confirmation process. -
The name of the custom function that handles the confirmation process.
-
Si
true, usa una función personalizada que definas para gestionar el proceso de restablecimiento de contraseña.El valor es
true. -
The name of the custom function that handles the password reset process.
-
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. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled.
Ocultar atributos Mostrar atributos
-
The name of the authentication provider. For Custom JWT authentication, this value is always
custom-token.El valor es
custom-token. -
The name of the authentication provider. For Custom JWT authentication, this value is always
custom-token.El valor es
custom-token. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. -
Un objeto de configuración para el proveedor de autenticación Custom JWT.
Ocultar atributos de configuración Show config attributes Objeto
-
Defines the expected values of the
audclaim in the external JWT. By default, the Custom JWT provider expectsaudto be your App ID. -
If
false, the external JWT must include all of the values defined inaudiencein itsaudclaim.Si
truees, un JWT es válido si alguno de los valores definidos enaudienceestá en suaudreclamo.El valor por defecto es
false. -
The cryptographic method that the external system uses to sign the JWT. Custom JWT authentication supports JWTs signed using any of the following algorithms:
- HS256
- RS256
-
If
true, the Custom JWT provider uses a signing algorithm and signing keys defined in a JSON Web Key (JWK) or JSON Web Key Set (JWKS). The JWK(S) must be accessible at the URL specified injwkURI. -
A URL that hosts a JWK or JWKS that describes the signing method and signing keys the Custom JWT provider should use. The JWK(S) may specify up to three signing keys and must use the RS256 algorithm.
-
-
Hide secret_config attribute Mostrar el atributo secret_config Objeto
-
A list of the names of up to three Secrets that each contain a signing key used by the external authentication system to sign JWTs. Each signing key Secret must be a string with length between 32 and 512 characters.
-
-
Metadata fields are additional data that describe each user. The value of each metadata field comes from some field included in the JWT from the external authentication system.
A user's metadata fields refresh whenever they log in.
Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
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.-
Si
true, este valor siempre debe estar presente en el JWT externo. -
The name of the field in the external JWT that contains the data.
To specify a field in an embedded object, use dot notation.
-
The name of the field in User object that holds the value.
-
Ocultar atributos Mostrar atributos
-
The name of the authentication provider. For Custom Function authentication, this value is always
custom-function.El valor es
custom-function. -
The name of the authentication provider. For Custom Function authentication, this value is always
custom-function.El valor es
custom-function. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. -
Un objeto de configuración para el proveedor de autenticación de función personalizada.
Ocultar atributo de configuración Show config attribute Objeto
-
The name of the custom authentication function that handles user logins.
-
Ocultar atributos Mostrar atributos
-
The name of the authentication provider. For Apple authentication, this value is always
oauth2-apple.El valor es
oauth2-apple. -
The name of the authentication provider. For Apple authentication, this value is always
oauth2-apple.El valor es
oauth2-apple. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. -
A configuration object for the Apple authentication provider.
Ocultar atributo de configuración Show config attribute Objeto
-
Your Apple Services ID.
Para aprender cómo obtener esto, consulta Crear un ID de Servicios.
-
-
Hide secret_config attribute Mostrar el atributo secret_config Objeto
-
El nombre de un Secreto que contiene tu secreto JWT de cliente.
To learn how to create this, see Create the Client Secret JWT.
-
-
A list of URIs that the OAuth flow should allow the user to redirect to.
Ocultar atributos Mostrar atributos
-
The name of the authentication provider. For Google authentication, this value is always
oauth2-google.El valor es
oauth2-google. -
The name of the authentication provider. For Google authentication, this value is always
oauth2-google.El valor es
oauth2-google. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. -
Un objeto de configuración para el proveedor de autenticación de Google.
Ocultar atributos de configuración Show config attributes Objeto
-
Un ID de cliente OAuth 2.0 para su proyecto de GCP.
To learn how to create one, see Set Up a Project in the Google API Console.
-
An OAuth 2.0
-
-
Hide secret_config attribute Mostrar el atributo secret_config Objeto
-
The name of a Secret that holds the OAuth 2.0 Client Secret for the Client ID specified in
config.clientId.
-
-
A list of URIs that the OAuth flow should allow the user to redirect to.
-
Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
Metadata fields are additional data that describe each user. The value of each metadata field comes from Google and is included in the authenticated JWT.
A user's metadata fields refresh whenever they log in.
-
If
true, include this metadata value in the OAuth JWT and the user's data. -
El nombre de una propiedad de metadatos de usuario accesible a través de OAuth, por ejemplo,
email.
-
-
A list of approved domain names for user accounts. If this is defined, a user must have an email address associated with their OAuth profile that has a domain included in this list.
Ocultar atributos Mostrar atributos
-
El nombre del proveedor de autenticación. Para la autenticación de Facebook, este valor es siempre
oauth2-facebook.El valor es
oauth2-facebook. -
El nombre del proveedor de autenticación. Para la autenticación de Facebook, este valor es siempre
oauth2-facebook.El valor es
oauth2-facebook. -
If
true, the auth provider is disabled. Users cannot log in through the provider until it is enabled. -
Un objeto de configuración para el proveedor de autenticación de Facebook.
-
Hide secret_config attribute Mostrar el atributo secret_config Objeto
-
The name of a Secret that holds your Facebook App Secret.
-
-
A list of URIs that the OAuth flow should allow the user to redirect to.
-
Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields Objeto
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.
A user's metadata fields refresh whenever they log in.
-
If
true, include this metadata value in the OAuth JWT and the user's data. -
El nombre de una propiedad de metadatos de usuario accesible a través de OAuth, por ejemplo,
email.
-
-
A list of approved domain names for user accounts. If this is defined, a user must have an email address associated with their OAuth profile that has a domain included in this list.
-
-
Ocultar los atributos custom_user_data Show custom_user_data attributes objeto | nulo
-
El nombre de la base de datos que contiene datos de usuario personalizados.
-
The name of the collection that contains custom user data.
-
El nombre de un campo que aparece en cada documento de datos de usuario personalizado y que contiene el ID de cuenta de usuario correspondiente a cada documento.
-
If
true, custom user data is enabled. -
The name of the linked MongoDB data source that contains custom user data.
-
The name of a user creation function that runs whenever a new user registers.
-
-
Hide data_api_config attributes Show data_api_config attributes objeto | nulo
-
A supported version of the Data API.
El valor es
v1. -
A data format supported by the Data API & custom endpoints.
Los valores son
JSONoEJSON. -
An application user's account ID. If defined, endpoints will always run as the specified user.
-
Código fuente convertido en string para una función que retorna el ID de 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 retornado 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
-
The service name.
-
El tipo de servicio.
-
Ocultar atributos de configuración Show config attributes Objeto
-
El nombre del clúster de la fuente de datos. El nombre puede tener un máximo de 64 caracteres y solo debe contener letras ASCII, números, guiones bajos y guiones.
-
El modo preferencia de lectura para solicitudes de lectura a la fuente de datos.
Los valores son
primary,primaryPreferred,secondary,secondaryPreferredonearest. -
Target read operations to specific members of a replica set.
Los valores son
server1oserver2. -
If true, clients may connect to the app over the MongoDB Wire Protocol [Deprecated].
-
-
A data access rule that define defines fallback user roles and query filters for collection's that don't have more specific permissions defined.
Ocultar los atributos default_rule Show default_rule attributes Objeto
-
Una lista ordenada de roles de usuario predeterminados.
Hide roles attributes Mostrar atributos de roles Objeto
-
Hide document_filters attributes Mostrar atributos document_filters Objeto
-
El nombre del rol.
-
Un objeto que asigna nombres de campos de documento a permisos de lectura y guardado para el campo y sus elementos secundarios.
-
Permisos de lectura y escritura para un campo.
Ocultar atributos de additional_fields Show additional_fields attributes Objeto
-
-
Una lista de filtros de consulta predeterminados.
Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
A filter that conditionally modifies incoming query operations before they run.
-
The filter's name.
-
A MongoDB query object.
-
Un objeto de proyección de MongoDB.
-
-
-
Ocultar atributos de reglas Mostrar atributos de normativas Objeto
A data access rule that defines user roles and query filters for a collection in a linked data source.
-
El nombre de una base de datos en la fuente de datos vinculada.
-
El nombre de una colección en el
databaseespecificado. -
A list of data access roles.
Hide roles attributes Mostrar atributos de roles Objeto
-
Hide document_filters attributes Mostrar atributos document_filters Objeto
-
El nombre del rol.
-
Un objeto que asigna nombres de campos de documento a permisos de lectura y guardado para el campo y sus elementos secundarios.
-
Permisos de lectura y escritura para un campo.
Ocultar atributos de additional_fields Show additional_fields attributes Objeto
-
-
Una lista de filtros para operaciones entrantes.
Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
A filter that conditionally modifies incoming query operations before they run.
-
The filter's name.
-
A MongoDB query object.
-
Un objeto de proyección de MongoDB.
-
-
Ocultar atributos Mostrar atributos
-
El valor es
mongodb-datafederation. -
El valor es
datalake. -
Ocultar atributo de configuración Show config attribute Objeto
-
-
Ocultar atributos de los endpoints Mostrar atributos de los 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. -
A data format supported by the Data API & custom endpoints.
Los valores son
JSONoEJSON. -
The endpoint functions's name.
-
Hide environments attribute Show environments attribute Objeto
-
An object that maps each possible environment name to definitions of the environment values available in that environment.
Hide values attributes Show values attributes Objeto
-
-
Hide functions attributes Show functions attributes Objeto
-
A JSON expression that evaluates to
trueif the Function is allowed to run in response to an incoming request. -
Un nombre único para la función.
-
If
true, the function is hidden from client applications. You can still call a private function from JSON expressions and other functions, including incoming webhooks and triggers. -
El código fuente convertido en string para la función. El código debe ser un ES6 válido.
-
Si
true, la función se ejecuta con todos los privilegios, omitiendo las reglas en 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. -
The stringified source code for a function that returns an application user's account ID. If defined, endpoints execute the function on every request and run as the user with the ID returned from the function. Cannot be used with
run_as_user_id.
-
-
Ocultar atributos graphql Mostrar atributos graphql Objeto
-
Ocultar atributos de configuración Show config attributes Objeto
-
If
true, generated schema type names use common English pluralization whenever possible.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 Show validation_settings attributes Objeto
-
Hide custom_resolvers attributes Mostrar atributos custom_resolvers Objeto
-
The name of the resolver's parent type. This can be
"Query","Mutation", or the name of a generated type if this is a computed property. -
The name of the custom resolver field that appears in the GraphQL schema.
-
El tipo de entrada que utiliza el resolvedor personalizado. Este valor debe corresponder al valor de
input_type:- Un tipo de entrada escalar debe usar
"scalar"o"scalar-list" - Un tipo de entrada generado debe utilizar
"generated"o"generated-list" - Se debe utilizar un tipo de entrada personalizado
"custom"
If undefined, the resolver does not accept an input.
Los valores son
scalar,scalar-list,generated,generated-listocustom. - Un tipo de entrada escalar debe usar
-
El tipo de carga útil que utiliza el resolvedor personalizado. Este valor debe corresponder al valor de
payload_type:- A scalar payload type must use
"scalar"or"scalar-list" - A generated payload type must use
"generated"or"generated-list" - Un tipo de carga útil personalizada debe usar
"custom"
If undefined, the resolver returns a
DefaultPayloadobject.Los valores son
scalar,scalar-list,generated,generated-listocustom. - A scalar payload type must use
-
El nombre de la función resolver.
-
-
-
[Deprecated] A list of legacy HTTP services. This is for backwards compatibility only.
Ocultar atributos https_endpoints Show https_endpoints attributes Objeto
-
The service name.
-
El tipo de servicio.
Los valores son
aws,twilio,github,gcmohttp.
-
-
Hide log_forwarders attributes Show log_forwarders attributes Objeto
-
Los valores son
auth,endpoint,function,graphql,push,schema,service,sync,triggerotrigger_error_handler. -
Los valores son
errorosuccess.
-
Hide schemas attributes Show schemas attributes Objeto
-
Metadata that describes which linked collection the schema applies to.
-
A valid schema for the collection.
Ocultar atributos del esquema Show schema attributes Objeto
-
The BSON type of the field.
Los valores son
object,array,string,number,int,long,double,decimal,date,timestamp,bool,null,regex,objectId,binary,uuid,function,javascript,symbol,minKeyomaxKey. -
A human-readable title for the schema.
-
Para los esquemas
object, un arreglo de nombres de campos que son obligatorios en instancias del objeto. -
An object where each field name is a property in the schema. The corresponding value is a schema definition for that field.
Hide properties attribute Mostrar atributo de propiedades Objeto
-
A valid schema for the collection.
-
-
-
Relationships to foreign collections. Each field name is a property in the schema. The corresponding value is a relationship definition for that field.
Ocultar el atributo de relaciones Show relationships attribute Objeto
-
A relationship definition.
Ocultar * atributos Mostrar * atributos Objeto
-
Una string de referencia para la colección externa.
-
The name of the field in the foreign collection that the relationship points to.
-
En caso de que
true:- the relationship may point to many foreign documents.
- the local field must be defined as an array in the collection schema.
-
-
-
-
[Deprecated] A list of legacy third-party non-HTTP services. This is for backwards compatibility only.
Hide services attributes Show services attributes Objeto
-
The service name.
-
El tipo de servicio.
Los valores son
aws,twilio,github,gcmohttp.
-
-
Ocultar atributos de sincronización Show sync attributes Objeto
-
El estado del servicio de sincronización (
"enabled","disabled"o vacío si la sincronización no está configurada). -
The name of a database in the synced cluster where App Services stores data in Development Mode. App Services automatically generates a schema for each synced type and maps each object type to a collection within the database.
-
Un arreglo 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.
-
The number of days the client can be offline before a client reset is required.
-
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. -
An array of the names of collections that are defined as asymmetric with Data Ingest, where clients can write data but not read.
-
-
Uno de: Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
The trigger type. For database triggers, this value is always
"DATABASE".El valor es
DATABASE. -
If
true, the trigger is disabled and does not listen for events or execute.El valor por defecto es
false. -
Un objeto que define los valores de configuración para el activador.
Ocultar atributos de configuración Show config attributes Objeto
-
El valor
_idde una fuente de datos MongoDB vinculada que contiene la colección observada.You can list services with the Get all services endpoint.
Data sources are services whose
typeis "mongodb-atlas". Use the_idvalue for the data source you want to link to the Trigger. -
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.
-
The name of a collection in the specified database. The trigger listens to events from this collection. If you omit this parameter, the Source Type changes to "Database."
-
Los tipos de eventos de cambio de MongoDB para los que el disparador escucha.
Valid operation types for all triggers include:
"INSERT""UPDATE""REPLACE""DELETE"
Additional valid operation types for database and deployment triggers include:
"CREATE_COLLECTION""MODIFY_COLLECTION""RENAME_COLLECTION""DROP_COLLECTION""SHARD_COLLECTION""RESHARD_COLLECTION""REFINE_COLLECTION_SHARD_KEY"
Los tipos de operación adicionales válidos para los activadores de implementación incluyen:
"DROP_DATABASE"
Para más información, consulta Configuración de activadores.
At least
1element. -
A $match expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event.
-
Una expresión $project devuelve solo los campos especificados. Puede incluir o excluir campos específicos, o incluir campos recién calculados.
-
If
true, indicates thatUPDATEchange events should include the most current majority-committed version of the modified document in thefullDocumentfield.El valor por defecto es
false. -
If true, indicates that
UPDATEchange events should include a snapshot of the modified document from immediately before the update was applied.Debe habilitar las preimágenes de documentos para su clúster para incluir estas instantáneas.
El valor por defecto es
false. -
If
true, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled.El valor por defecto 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 por defecto es
false. -
Si
true, el activador usará la opción maximizar el rendimiento.El valor por defecto es
false. -
If
true, event ordering is disabled and this Trigger can process events in parallel. Iffalse, event ordering is enabled and the Trigger executes events serially.El valor por defecto es
false.
-
-
The ID of the function that the trigger calls when it fires.
This value is the same as
event_processors.FUNCTION.function_id. You can either define the value here or inevent_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as
event_processors.FUNCTION.function_name. You can either define the value here or inevent_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger. -
An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.
Hide event_processors attributes Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Show config attributes Objeto
-
The ID of the function that the trigger calls when it fires.
This value is the same as the root-level
function_id. You can either define the value here or infunction_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as the root-level
function_name. You can either define the value here or infunction_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Show AWS_EVENTBRIDGE attribute Objeto
-
-
An object that defines custom error handling for an AWS EventBridge trigger. Valid only for
"DATABASE"type triggers with"AWS_EVENTBRIDGE"event processors.Hide error_handler attribute Mostrar atributo error_handler Objeto
Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
The trigger type. For authentication triggers, this value is always
"AUTHENTICATION".El valor es
AUTHENTICATION. -
If
true, the trigger is disabled and does not listen for events or execute.El valor por defecto es
false. -
Un objeto que define los valores de configuración para el activador.
Ocultar atributos de configuración Show config attributes Objeto
-
El tipo de evento de autenticación para el que el activador escucha.
Los valores son
LOGIN,CREATEoDELETE. -
The type(s) of authentication provider that the trigger listens to.
Los valores son
anon-user,api-key,custom-token,custom-function,local-userpass,oauth2-apple,oauth2-facebookooauth2-google.
-
-
The ID of the function that the trigger calls when it fires.
This value is the same as
event_processors.FUNCTION.function_id. You can either define the value here or inevent_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as
event_processors.FUNCTION.function_name. You can either define the value here or inevent_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger. -
An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.
Hide event_processors attributes Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Show config attributes Objeto
-
The ID of the function that the trigger calls when it fires.
This value is the same as the root-level
function_id. You can either define the value here or infunction_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as the root-level
function_name. You can either define the value here or infunction_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Show AWS_EVENTBRIDGE attribute Objeto
-
Ocultar atributos Mostrar atributos
-
El nombre del activador.
-
The trigger type. For scheduled triggers, this value is always
"SCHEDULED".El valor es
SCHEDULED. -
If
true, the trigger is disabled and does not listen for events or execute.El valor por defecto es
false. -
Un objeto que define los valores de configuración para el activador.
Ocultar atributos de configuración Show config attributes Objeto
-
Una expresión cron que especifica cuándo se ejecuta el disparador.
-
If
true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled.
-
-
The ID of the function that the trigger calls when it fires.
This value is the same as
event_processors.FUNCTION.function_id. You can either define the value here or inevent_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_id, el backend lo duplica enevent_processors.FUNCTION.function_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as
event_processors.FUNCTION.function_name. You can either define the value here or inevent_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
function_name, el backend lo duplica enevent_processors.FUNCTION.function_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger. -
An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.
Hide event_processors attributes Mostrar atributos de event_processors Objeto
-
Ocultar atributo FUNCTION Mostrar atributo FUNCIÓN Objeto
-
Ocultar atributos de configuración Show config attributes Objeto
-
The ID of the function that the trigger calls when it fires.
This value is the same as the root-level
function_id. You can either define the value here or infunction_id. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_id, el backend lo duplica enfunction_id.If you define
function_id,event_processorsis not required. You must provide eitherfunction_idorevent_processorswhen updating a trigger. -
The name of the function that the trigger calls when it fires, i.e. the function described by
function_id.This value is the same as the root-level
function_name. You can either define the value here or infunction_name. The App Services backend duplicates the value to the configuration location where you did not define it.Por ejemplo, si se define
event_processors.FUNCTION.function_name, el backend lo duplica enfunction_name.If you define
function_name,event_processorsis not required. You must provide eitherfunction_nameorevent_processorswhen updating a trigger.
-
-
-
Ocultar el atributo AWS_EVENTBRIDGE Show AWS_EVENTBRIDGE attribute Objeto
-
-
-
Hide values attributes Show values attributes Objeto
-
Si
true, el valor es una referencia por nombre a un Secret.
A zip file containing the App configuration file directory
-
-
Invalid request
-
Error pulling configuration
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
}
]
}