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
| Guide | Use it when |
|---|---|
| Register users | You need sign-up with a password, a passkey, GitHub, or Google. |
| Sign users in | You need sign-in with a password, a passkey, an emailed code, GitHub, or Google. |
| Turn on two-factor authentication | Users need authenticator codes and recovery codes. |
| Reset a forgotten password | A user cannot sign in and needs a reset email. |
| Add, rename, and remove passkeys | A signed-in user manages their passkeys. |
| Sign in with an emailed code | You need a one-time code. Sign-up and the magic link stay off until you enable them. |
| Add GitHub or Google | You add an external provider. The password facade does not map it. |
| Require step-up before sensitive actions | An endpoint returns 401 or 403 until the user proves their identity again. |
| Run an app with no public sign-up | Accounts are created by an admin. There is no public register route. |
| Sign users out | You need logout for the cookie, Identity bearer, or JWT stack. |
| Change a user's email or password | A signed-in user changes their email or password. |
| Link and unlink GitHub or Google accounts | A signed-in user connects or disconnects a provider login. |
| List and revoke signed-in sessions | A user sees where they are signed in and signs out other browsers or devices. |
| Call the API from a browser | You set up cookies, CSRF tokens, and CORS for a browser client. |
| Prepare for production | You are about to deploy. |
Route tables for every module are in the Endpoint reference. The password facade route list is the composition table.