{ "$schema": "https://mintlify.com/docs.json", "name": "Stack Auth Documentation", "theme": "mint", "logo": { "dark": "/images/logo-dark.svg", "light": "/images/logo-light.svg" }, "favicon": "/images/favicon.ico", "colors": { "primary": "#6b5df7", "light": "#8b7cf9", "dark": "#6b5df7" }, "background": { "color": { "dark": "#09090b" } }, "fonts": { "heading": { "family": "Geist", "weight": 500 }, "body": { "family": "Geist", "weight": 400 } }, "navbar": { "links": [ { "type": "github", "href": "https://github.com/stack-auth/stack-auth" } ], "primary": { "type": "button", "label": "Dashboard", "href": "https://app.stack-auth.com" } }, "navigation": { "tabs": [ { "tab": "Documentation", "pages": [ "index", "guides/faq", { "group": "Getting Started", "pages": [ "guides/getting-started/setup", "guides/getting-started/user-fundamentals", "guides/getting-started/ai-integration" ] }, { "group": "Going Further", "pages": [ "guides/going-further/stack-app", "guides/going-further/backend-integration", "guides/going-further/local-development", "guides/going-further/user-metadata" ] }, { "group": "Apps", "pages": [ { "group": "Authentication", "icon": "/images/app-icons/authentication.svg", "pages": [ "guides/apps/authentication/overview", "guides/apps/authentication/user-onboarding", "guides/apps/authentication/connected-accounts", "guides/apps/authentication/jwts", "guides/apps/authentication/sign-up-rules", "guides/apps/authentication/cli-authentication", { "group": "All Auth Providers", "root": "guides/apps/authentication/auth-providers", "pages": [ "guides/apps/authentication/auth-providers/apple", "guides/apps/authentication/auth-providers/bitbucket", "guides/apps/authentication/auth-providers/discord", "guides/apps/authentication/auth-providers/facebook", "guides/apps/authentication/auth-providers/github", "guides/apps/authentication/auth-providers/gitlab", "guides/apps/authentication/auth-providers/google", "guides/apps/authentication/auth-providers/linkedin", "guides/apps/authentication/auth-providers/microsoft", "guides/apps/authentication/auth-providers/passkey", "guides/apps/authentication/auth-providers/spotify", "guides/apps/authentication/auth-providers/twitch", "guides/apps/authentication/auth-providers/two-factor-auth", "guides/apps/authentication/auth-providers/x-twitter" ] } ] }, "guides/apps/emails/overview", "guides/apps/payments/overview", "guides/apps/analytics/overview", { "group": "Teams", "icon": "/images/app-icons/teams.svg", "pages": [ "guides/apps/teams/overview", "guides/apps/teams/team-selection" ] }, "guides/apps/fraud-protection/overview", "guides/apps/rbac/overview", "guides/apps/api-keys/overview", "guides/apps/data-vault/overview", "guides/apps/webhooks/overview", "guides/apps/launch-checklist/overview" ] }, { "group": "Integrations", "pages": [ "guides/integrations/supabase/overview", "guides/integrations/convex/overview", "guides/integrations/vercel/overview" ] }, { "group": "Other", "pages": [ "guides/other/self-host", "guides/other/mcp-setup", { "group": "Tutorials", "pages": [ "guides/other/tutorials/build-a-saas-with-stack-auth", "guides/other/tutorials/build-a-team-based-app", "guides/other/tutorials/ship-production-ready-auth" ] }, "guides/other/showcase" ] } ] }, { "tab": "SDK Reference", "pages": [ "sdk/overview", { "group": "Objects", "pages": ["sdk/objects/stack-app"] }, { "group": "Types", "pages": [ "sdk/types/user", "sdk/types/team", "sdk/types/team-user", "sdk/types/team-permission", "sdk/types/team-profile", "sdk/types/contact-channel", "sdk/types/email", "sdk/types/api-key", "sdk/types/project", "sdk/types/connected-account", "sdk/types/item", "sdk/types/customer" ] }, { "group": "Hooks", "pages": ["sdk/hooks/use-stack-app", "sdk/hooks/use-user"] } ] }, { "tab": "REST API", "pages": [ "api/overview", { "group": "Client API", "pages": [ { "group": "Anonymous", "expanded": false, "pages": ["api/client/anonymous/sign-up"] }, { "group": "API Keys", "expanded": false, "pages": [ "api/client/api-keys/list-user-api-keys", "api/client/api-keys/create-user-api-key", "api/client/api-keys/check-user-api-key", "api/client/api-keys/get-user-api-key", "api/client/api-keys/update-user-api-key" ] }, { "group": "Contact Channels", "expanded": false, "pages": [ "api/client/contact-channels/list", "api/client/contact-channels/create", "api/client/contact-channels/verify", "api/client/contact-channels/verify-check-code", "api/client/contact-channels/get", "api/client/contact-channels/update", "api/client/contact-channels/delete", "api/client/contact-channels/send-verification-code" ] }, { "group": "Emails", "expanded": false, "pages": [ "api/client/emails/notification-preference", "api/client/emails/notification-category" ] }, { "group": "OAuth", "expanded": false, "pages": [ "api/client/oauth/list-providers", "api/client/oauth/authorize", "api/client/oauth/token", "api/client/oauth/get-provider", "api/client/oauth/update-provider", "api/client/oauth/delete-provider" ] }, { "group": "OTP", "expanded": false, "pages": [ "api/client/otp/mfa-sign-in", "api/client/otp/send-sign-in-code", "api/client/otp/sign-in", "api/client/otp/check-code" ] }, { "group": "Password", "expanded": false, "pages": [ "api/client/password/reset", "api/client/password/reset-check-code", "api/client/password/send-reset-code", "api/client/password/set", "api/client/password/sign-in", "api/client/password/sign-up", "api/client/password/update" ] }, { "group": "Payments", "expanded": false, "pages": [ "api/client/payments/create-purchase-url", "api/client/payments/purchase-session", "api/client/payments/validate-code", "api/client/payments/get-item", "api/client/payments/update-quantity" ] }, { "group": "Permissions", "expanded": false, "pages": [ "api/client/permissions/list-project-permissions", "api/client/permissions/list-team-permissions" ] }, { "group": "Projects", "expanded": false, "pages": ["api/client/projects/current-project"] }, { "group": "Sessions", "expanded": false, "pages": [ "api/client/sessions/current", "api/client/sessions/refresh" ] }, { "group": "Teams", "expanded": false, "pages": [ "api/client/teams/list", "api/client/teams/create", "api/client/teams/get", "api/client/teams/update", "api/client/teams/delete", "api/client/teams/list-invitations", "api/client/teams/send-invitation-code", "api/client/teams/get-invitation", "api/client/teams/accept-invitation-by-id", "api/client/teams/accept-invitation", "api/client/teams/accept-check-code", "api/client/teams/accept-details", "api/client/teams/list-member-profiles", "api/client/teams/get-member-profile", "api/client/teams/update-member-profile", "api/client/teams/add-membership", "api/client/teams/remove-membership" ] }, { "group": "Users", "expanded": false, "pages": [ "api/client/users/get-current", "api/client/users/update-current", "api/client/users/delete-current" ] } ] }, { "group": "Server API", "pages": [ { "group": "Anonymous", "expanded": false, "pages": ["api/server/anonymous/sign-up"] }, { "group": "API Keys", "expanded": false, "pages": [ "api/server/api-keys/list-team-api-keys", "api/server/api-keys/create-team-api-key", "api/server/api-keys/check-team-api-key", "api/server/api-keys/get-team-api-key", "api/server/api-keys/update-team-api-key", "api/server/api-keys/list-user-api-keys", "api/server/api-keys/create-user-api-key", "api/server/api-keys/check-user-api-key", "api/server/api-keys/get-user-api-key", "api/server/api-keys/update-user-api-key" ] }, { "group": "CLI Authentication", "expanded": false, "pages": [ "api/server/cli-authentication/cli-auth", "api/server/cli-authentication/cli-auth-complete", "api/server/cli-authentication/cli-auth-poll" ] }, { "group": "Contact Channels", "expanded": false, "pages": [ "api/server/contact-channels/list", "api/server/contact-channels/create", "api/server/contact-channels/verify", "api/server/contact-channels/verify-check-code", "api/server/contact-channels/get", "api/server/contact-channels/update", "api/server/contact-channels/delete", "api/server/contact-channels/send-verification-code" ] }, { "group": "Emails", "expanded": false, "pages": [ "api/server/emails/capacity-boost", "api/server/emails/delivery-info", "api/server/emails/list-outbox", "api/server/emails/get-outbox", "api/server/emails/update-outbox", "api/server/emails/render-email", "api/server/emails/send-email", "api/server/emails/notification-preference", "api/server/emails/notification-category" ] }, { "group": "OAuth", "expanded": false, "pages": [ "api/server/oauth/list-providers", "api/server/oauth/create-provider", "api/server/oauth/authorize", "api/server/oauth/token", "api/server/oauth/get-provider", "api/server/oauth/update-provider", "api/server/oauth/delete-provider" ] }, { "group": "OTP", "expanded": false, "pages": [ "api/server/otp/mfa-sign-in", "api/server/otp/send-sign-in-code", "api/server/otp/sign-in", "api/server/otp/check-code" ] }, { "group": "Password", "expanded": false, "pages": [ "api/server/password/reset", "api/server/password/reset-check-code", "api/server/password/send-reset-code", "api/server/password/set", "api/server/password/sign-in", "api/server/password/sign-up", "api/server/password/update" ] }, { "group": "Payments", "expanded": false, "pages": [ "api/server/payments/create-purchase-url", "api/server/payments/purchase-session", "api/server/payments/validate-code", "api/server/payments/get-item", "api/server/payments/update-quantity" ] }, { "group": "Permissions", "expanded": false, "pages": [ "api/server/permissions/list-project-permission-definitions", "api/server/permissions/create-project-permission-definition", "api/server/permissions/delete-project-permission-definition", "api/server/permissions/update-project-permission-definition", "api/server/permissions/list-project-permissions", "api/server/permissions/assign-project-permission", "api/server/permissions/remove-project-permission", "api/server/permissions/list-team-permission-definitions", "api/server/permissions/create-team-permission-definition", "api/server/permissions/delete-team-permission-definition", "api/server/permissions/update-team-permission-definition", "api/server/permissions/list-team-permissions", "api/server/permissions/assign-team-permission", "api/server/permissions/remove-team-permission" ] }, { "group": "Projects", "expanded": false, "pages": ["api/server/projects/current-project"] }, { "group": "Sessions", "expanded": false, "pages": [ "api/server/sessions/list", "api/server/sessions/create", "api/server/sessions/current", "api/server/sessions/refresh", "api/server/sessions/get" ] }, { "group": "Teams", "expanded": false, "pages": [ "api/server/teams/list", "api/server/teams/create", "api/server/teams/get", "api/server/teams/update", "api/server/teams/delete", "api/server/teams/list-invitations", "api/server/teams/send-invitation-code", "api/server/teams/get-invitation", "api/server/teams/accept-invitation-by-id", "api/server/teams/accept-invitation", "api/server/teams/accept-check-code", "api/server/teams/accept-details", "api/server/teams/list-member-profiles", "api/server/teams/get-member-profile", "api/server/teams/update-member-profile", "api/server/teams/add-membership", "api/server/teams/remove-membership" ] }, { "group": "Users", "expanded": false, "pages": [ "api/server/users/list", "api/server/users/create", "api/server/users/get-current", "api/server/users/update-current", "api/server/users/delete-current", "api/server/users/get", "api/server/users/update", "api/server/users/delete" ] } ] }, { "group": "Webhooks", "pages": [ { "group": "Teams", "expanded": false, "pages": [ "api/webhooks/teams/team-created", "api/webhooks/teams/team-deleted", "api/webhooks/teams/team-updated", "api/webhooks/teams/team-membership-created", "api/webhooks/teams/team-membership-deleted", "api/webhooks/teams/team-permission-created", "api/webhooks/teams/team-permission-deleted" ] }, { "group": "Users", "expanded": false, "pages": [ "api/webhooks/users/user-created", "api/webhooks/users/user-deleted", "api/webhooks/users/user-updated" ] } ] } ] } ] }, "footer": { "socials": { "x": "https://x.com/stack_auth", "github": "https://github.com/stack-auth/stack", "discord": "https://discord.stack-auth.com" } }, "seo": { "metatags": { "robots": "noindex" } }, "redirects": [] }