authApi — a named-method wrapper around register/login/logout and session checks, built on the apiRequest helper.

Authentication client

Wraps every endpoint from the Authentication guide into one object, authApi, built on the apiRequest helper. This is the form you'd actually keep in an app — the raw calls on the guide page are there to show you the wire format, not to be copy-pasted one at a time.

import { apiRequest } from "./client"; // wherever you put the Setup page's helper

const API_BASE = "https://api.myapp.com";

export const authApi = {
  register: (input: { email: string; password: string; name: string }) =>
    apiRequest(API_BASE, "POST", "/auth/register", input),

  login: (input: { email: string; password: string }) =>
    apiRequest(API_BASE, "POST", "/auth/login", input),

  logout: () => apiRequest(API_BASE, "POST", "/auth/logout"),

  me: () => apiRequest(API_BASE, "GET", "/auth/me"),

  check: () => apiRequest(API_BASE, "GET", "/auth/check"),

  verifyEmail: (code: string) =>
    apiRequest(API_BASE, "POST", "/auth/verify-email", { code }),

  resendVerification: (email: string) =>
    apiRequest(API_BASE, "POST", "/auth/verify-email/resend", { email }),

  getInviteInfo: (token: string) =>
    apiRequest(API_BASE, "GET", `/auth/invite/info?token=${encodeURIComponent(token)}`),

  completeInviteRegistration: (input: {
    code: string;
    name: string;
    password: string;
    confirmPassword: string;
  }) => apiRequest(API_BASE, "POST", "/auth/invite/register", input),
};

Every method returns exactly what the matching endpoint documents — authApi doesn't reshape responses or swallow errors, it only fills in the method/path/body so call sites don't have to repeat them. register/login/logout/verifyEmail/resendVerification/the invite methods are documented on the Authentication guide; me and check are documented on Sessions → Checking who's logged in — they live on authApi rather than sessionsApi because that's where this codebase's own reference frontend keeps them.

Using it

const result = await authApi.login({ email, password });

if (result.requiresVerification) {
  // show a "verify your email" screen
} else {
  setUser(result.user); // cookies are already set by the browser
}

try {
  await authApi.register({ email, password, name });
} catch (err) {
  // err is the parsed { error, message } body — see Error Handling
  showError(err.message ?? err.error);
}

await authApi.logout();
setUser(null);
window.location.href = "/login";

Setup — the apiRequest helper this is built on
Authentication — full request/response/error reference for each of these endpoints

Authentication

Authentication client

Using it

Next

On this page