Authentication

Your app never handles passwords or OAuth itself. The platform signs the user in, and useBridgeAuth makes the result available to your code and to every API call the SDK makes.

useBridgeAuth

Call it once, near the root of your app.

import { useBridgeAuth, useUser } from '@cskn/sdk';

function Root() {
  const { token, user, isReady } = useBridgeAuth();
  const { data: profile } = useUser({ enabled: isReady && !!token });

  if (!isReady) return <Splash />;
  if (!token) return <SignIn />;
  return <Home profile={profile} />;
}

boolean

true once the hook knows whether there is a user. Wait for it before calling authenticated endpoints, or the first requests go out without credentials and fail with 401.

string | null

Non-null when a user is signed in. Treat it as a flag; the SDK attaches credentials to requests for you.

{ sub?, name?, email?, picture?, username? } | null

Basic identity of the signed-in user, available without a network round trip.

How it resolves

Surface	Source	Result
Browser, signed in	`window.cskn.auth` from the host	Ready at once. API calls go through your origin’s `/api` proxy, which forwards the session cookie.
Browser, signed out	—	Ready at once with `token: null`.
Native shell	`auth` message over the bridge	Ready when the shell answers. The bearer token is attached to every SDK request.

Never build the auth URLs yourself; take them from the SDK.

import { login, logout, logoutUrl } from '@cskn/sdk';

login();                       // back to the current page after sign-in
login('https://my-app.cskn.app/welcome');

logout();                      // back to the current origin
logout({ returnTo: 'https://…', allSessions: true });

string

Where to send the user after logout. Defaults to the current origin.

boolean

default:"false"

End every cskn session on this device, not just this app’s. Adds session=all to the link.

logoutUrl(options) returns the same link without navigating. Use it when something else has to follow the link, for example a confirmation dialog. @cskn/ui ships one: LogoutConfirm.

Lower-level API

The hook is built from functions you can use outside React:

import { initAuth, requestToken, getToken, getUser, onTokenChange, onUserChange } from '@cskn/sdk';

const stop = initAuth();               // listen for the shell's auth messages; returns cleanup
const unsubscribe = onTokenChange((t) => console.log('token', t));
requestToken();                        // ask the shell to resend the current token

Get started

Concepts

useBridgeAuth

How it resolves

Lower-level API

​useBridgeAuth

​How it resolves

​Sign in and sign out

​Lower-level API

useBridgeAuth

How it resolves

Sign in and sign out

Lower-level API