Authentication Triggers

Overview

Authentication triggers allow you to execute server-side logic whenever a user interacts with an authentication provider. You can use authentication triggers to implement advanced user management, including storing new user data in your linked cluster, maintaining data integrity upon user deletion, or calling a service with a user's information when they log in.

Example

An online store wants to store custom metadata for each of its customers in MongoDB Atlas. Each customer should have a document in the store.customers collection where metadata about them can be recorded and queried.

To guarantee that the collection represents each customer, the store creates an authentication Trigger that listens for newly created users in the email/password authentication provider. When the trigger observes a CREATE event, it passes the authentication event object to its linked function, createNewUserDocument. The Realm Function creates a new document describing the user and their activity and inserts it into the store.customers collection.

exports = async function(authEvent) {
  const mongodb = context.services.get("mongodb-atlas");
  const customers = mongodb.db("store").collection("customers");
  const { user, time } = authEvent;
  const newUser = { ...user, eventLog: [ { "created": time } ] };
  await customers.insertOne(newUser);
}

Configuration

Authentication Triggers have the following configuration options:

Authentication Events

Authentication events represent user interactions with an authentication provider. Each event corresponds to a single user action with one of the following operation types:

Authentication event objects have the following form:

{
  "operationType": <string>,
  "providers": <array of strings>,
  "user": <user object>,
  "time": <ISODate>
}