Quickstart

Visit Backend JS SDK's quickstart page.

Initialize SDK

import { CakeAuth } from "@cakeauth/backend";
 
const cakeauth = new CakeAuth({
  privateKey: process.env.CAKEAUTH_PRIVATE_KEY,
});
 
// Sample usage
const res = await cakeauth.identifiers.getIdentifiers();

The CAKEAUTH_PRIVATE_KEY value is your private key for your environment. Don't know where to get that? Check out this quick cheat sheet.

References

Identifiers

identifiers.getIdentifiers()

Get identifiers for a user.

API: GET /v1/identifiers

identifiers.createIdentifier()

Create/assign a new identifier for a user.

API: POST /v1/identifiers

identifiers.deleteIdentifier()

Remove an identifier from a user.

API: DELETE /v1/identifiers/:identifier_id

identifiers.setIdentifierPassword()

Set identifier's password.

API: POST /v1/identifiers/:identifier_id/set_password

Sessions

sessions.getSessions()

Get list of sessions for a user.

API: GET /v1/sessions

sessions.createSession()

Initiate a new session for a user.

API: POST /v1/sessions

sessions.refreshSessionToken()

Refresh session's access token based on its session ID.

API: POST /v1/sessions/:session_id/tokens

sessions.revokesession()

Revoke a session based on its session ID.

API: POST /v1/sessions/:session_id/revoke

Users

users.getUsers()

Get users for the current environment.

API: GET /v1/users

users.getUserDetails()

Get a user's details.

API: GET /v1/users/:user_id

users.createUser()

Create a new user.

API: POST /v1/users

users.banUser()

Ban a user.

API: POST /v1/users/:user_id/ban

users.unbanUser()

Unban a user.

API: POST /v1/users/:user_id/unban

users.deleteUser()

Permanently delete a user. Caution: this action cannot be undone!

API: DELETE /v1/users/:user_id