Authentication - Set up access token permissions with Firebase

Follow the following steps to start configure your authentication endpoint and start building your own security logic.


  1. Install the liveblocks/node package

    Let’s first install the @liveblocks/node package in your Firebase functions project.

    $npm install @liveblocks/node
  2. Set up authentication endpoint

    Create a new Firebase callable function as shown below. This is where you will implement your security and define if the current user has access to a specific room.

    const functions = require("firebase-functions");const { Liveblocks } = require("@liveblocks/node");
    const liveblocks = new Liveblocks({ secret: "sk_prod_xxxxxxxxxxxxxxxxxxxxxxxx",});
    exports.auth = functions.https.onCall(async (data, context) => { // Get the current user from your database const user = __getUserFromDB__(data);
    // Start an auth session inside your endpoint const session = liveblocks.prepareSession(, { userInfo: user.metadata }, // Optional );
    // Implement your own security, and give the user access to the room if ( && __shouldUserHaveAccess__(user, { session.allow(, session.FULL_ACCESS); }
    // Authorize the user and return the result const { status, body } = await session.authorize(); return JSON.parse(body);});
  3. Set up the client

    On the front end, you can now replace the publicApiKey option with authEndpoint pointing to the endpoint you just created.

    import { createClient } from "@liveblocks/client";import firebase from "firebase";import "firebase/functions";
    firebase.initializeApp({ /* Firebase config */});
    const auth = firebase.functions().httpsCallable("liveblocks-auth");
    // Create a Liveblocks clientconst client = createClient({ authEndpoint: async (room) => (await auth({ room })).data,});

More information

Both userId and userInfo can then be used in your JavaScript application as such:

const self = room.getSelf(); // or useSelf() in Reactconsole.log(;console.log(;
Auth diagram