Access Custom User Data - Node.js SDK

Before You Begin

To use custom user data, you must first enable custom user data in App Services:

1. Create an App.

2. Enable custom user data.

3. Create a user to apply custom data to.

Read Custom User Data

You retrieve custom user data in the customData property of the User object:

const customUserData = app.currentUser.customData;
console.log(customUserData);

App Services does not immediately update the value of the User.customData when underlying data changes. Instead, App Services fetches the most recent version of custom user data whenever a user refreshes their access token or when you explicitly call refreshCustomData(), which ensures your app has the latest custom user data.

const updatedCustomUserData = await user.refreshCustomData();
console.log(updatedCustomUserData);

Write to Custom User Data with a MongoClient

Using standard CRUD operations through the MongoDB Atlas service and a mongoClient, you can access a user's custom data. The following example updates a user's custom data to alter the user's favoriteColor to pink.

// A user must be logged in to use a mongoClient
const user = app.currentUser;
const mongo = user.mongoClient("mongodb-atlas");
const collection = mongo.db("custom-user-data-database").collection("custom-user-data");
// Query for the user object of the logged in user
const filter = { userId: user.id};
// Set the logged in user's favorite color to pink
const update = { $set: { favoriteColor: "pink" }};
// Insert document if it doesn't already exist
const options = { upsert: true };
const result = await collection.updateOne(filter, update, options);