JS Backend SDK

Before continuing

Make sure you have:

• Setup your account

CakeAuth JavaScript backend SDK is a wrapper which exposes the CakeAuth Backend APIs. You can use it to build on top of your application.

If you're not into using an SDK, you can also use the CakeAuth Backend APIs directly.

Installation

npm install @cakeauth/backend

Usage

To start using the SDK, you can initiate a new instance of the CakeAuth class:

import { CakeAuth } from "@cakeauth/backend";
 
const cakeauth = new CakeAuth({
  privateKey: process.env.CAKEAUTH_PRIVATE_KEY,
});

To better organize the APIs, all the "endpoints" are mounted under the CakeAuth's client object. For example, to create a new user, you can use the cakeauth.users.createUser method:

const user = await cakeauth.users.createUser({
  external_id: "123456",
});

You can find the full list of available methods in the Backend SDK reference.

What's next?

TODO:

• Add more auth options
• protect pages/components
• protect API routes
• session management
• more on sdk reference