Upgrade to 4.0Changelog

Guides

Task list for registration, sign-in, account management, and production setup.

Each guide is one task. Examples use the password facade prefix /auth, unless a section names another prefix. See Password auth.

Not sure which call to make? See Choose your sign-in setup.

Coming from MapIdentityApi? See What MapIdentityApi maps. Shared routes side by side compares register, login, reset, and 2FA.

I want to

GuideUse it when
Register usersYou need sign-up with a password, a passkey, GitHub, or Google.
Sign users inYou need sign-in with a password, a passkey, an emailed code, GitHub, or Google.
Turn on two-factor authenticationUsers need authenticator codes and recovery codes.
Reset a forgotten passwordA user cannot sign in and needs a reset email.
Add, rename, and remove passkeysA signed-in user manages their passkeys.
Sign in with an emailed codeYou need a one-time code. Sign-up and the magic link stay off until you enable them.
Add GitHub or GoogleYou add an external provider. The password facade does not map it.
Require step-up before sensitive actionsAn endpoint returns 401 or 403 until the user proves their identity again.
Run an app with no public sign-upAccounts are created by an admin. There is no public register route.
Sign users outYou need logout for the cookie, Identity bearer, or JWT stack.
Change a user's email or passwordA signed-in user changes their email or password.
Link and unlink GitHub or Google accountsA signed-in user connects or disconnects a provider login.
List and revoke signed-in sessionsA user sees where they are signed in and signs out other browsers or devices.
Call the API from a browserYou set up cookies, CSRF tokens, and CORS for a browser client.
Prepare for productionYou are about to deploy.

Route tables for every module are in the Endpoint reference. The password facade route list is the composition table.