Quickstart

Quickstart: install, initialize, and run the first login flow

Use this page when you want the minimum sequence required to get an authenticated session working before diving into provider-specific setup details.

Active docs channel
v1.0
Stable release stream
Version selection is persisted locally so teams can preview upcoming changes without leaving the docs flow.

Install

Add the core package first. Provider adapters can be layered in after the base login flow is working with the redirect and environment values for your target runtime.

Initialize

Initialization should happen once at app startup. Register the client identity, callback URI, and enabled providers there so the rest of the application only consumes the shared auth client.

Deployment discipline

Keep callback URIs, issuers, and enabled providers aligned across local, staging, and production. Quickstart failures are usually environment mismatches, not SDK defects.

Run the login flow

Call `auth.login` with the first provider you want to support. Once that path is working, move to the provider docs to add issuer-specific settings, advanced options, and rollout guidance.

  • Start with a single provider so redirect and session handling are easy to validate.
  • Test the complete path: initialize, login, callback handling, session read, refresh, and logout.
  • Only widen scopes or add multiple providers after the first working flow is stable.

Verification checklist

Client checks

Confirm login resolves, callback handling succeeds, and `auth.session.current()` returns a populated session.

Operational checks

Verify redirect registration, provider scopes, and environment variables before moving into staging rollout.

Docs are structured for static generation, searchable navigation, and provider-consistent implementation guides.
Edit this page on GitHub