models

package

Go to main page

Versions in this module

v1

v1.5.2

Jan 5, 2026

Changes in this version

+ type Handler interface

+ Handle func(w http.ResponseWriter, r *http.Request)

type PluginContext

+ Plugin Plugin

+ type RouteHandler func() http.Handler

+ func WrapHandler(h Handler) RouteHandler

+ type RouteMiddleware func(http.Handler) http.Handler

v1.5.1

Jan 3, 2026

Changes in this version

type DatabaseConfig

+ URL string

v1.4.0

Dec 22, 2025

Changes in this version

+ type ApiMiddleware struct

+ AdminAuth func() func(http.Handler) http.Handler

+ Auth func() func(http.Handler) http.Handler

+ CSRF func() func(http.Handler) http.Handler

+ CorsAuth func() func(http.Handler) http.Handler

+ EndpointHooks func() func(http.Handler) http.Handler

+ OptionalAuth func() func(http.Handler) http.Handler

+ RateLimit func() func(http.Handler) http.Handler

+ type AuthApi interface

+ ChangePassword func(ctx context.Context, rawToken string, newPassword string) error

+ EmailChange func(ctx context.Context, userID string, newEmail string, callbackURL *string) error

+ GetMe func(ctx context.Context, userID string) (*MeResult, error)

+ PrepareOAuth2Login func(ctx context.Context, providerName string) (*OAuth2LoginResult, error)

+ ResetPassword func(ctx context.Context, email string, callbackURL *string) error

+ SendEmailVerification func(ctx context.Context, userID string, callbackURL *string) error

+ Services func() *AuthServices

+ SignInWithEmailAndPassword func(ctx context.Context, email string, password string, callbackURL *string) (*SignInResult, error)

+ SignInWithOAuth2 func(ctx context.Context, providerName string, code string, state string, ...) (*SignInResult, error)

+ SignOut func(ctx context.Context, sessionToken string) error

+ SignUpWithEmailAndPassword func(ctx context.Context, name string, email string, password string, ...) (*SignUpResult, error)

+ VerifyEmail func(ctx context.Context, rawToken string) (*VerifyEmailResult, error)

+ type AuthServices struct

+ Accounts AccountService

+ Mailers MailerService

+ Passwords PasswordService

+ RateLimits RateLimitService

+ Sessions SessionService

+ Tokens TokenService

+ Users UserService

+ Verifications VerificationService

+ type AuthSettings struct

+ CreatedAt time.Time

+ Key string

+ UpdatedAt time.Time

+ Value json.RawMessage

+ func (AuthSettings) TableName() string

type BasePlugin

+ func (p *BasePlugin) EndpointHooks() any

+ func (p *BasePlugin) SetEndpointHooks(hooks any)

+ func (p *BasePlugin) SetWebhooks(hooks any)

+ func (p *BasePlugin) Webhooks() any

type Config

+ Email EmailConfig

+ Logger LoggerConfig

+ Mode Mode

+ Webhooks WebhooksConfig

+ type ConfigManager interface

+ GetConfig func() *Config

+ Init func() error

+ Load func() error

+ Update func(key string, value any) error

+ Watch func(ctx context.Context) (<-chan *Config, error)

+ type EmailChangeRequestResult struct

+ Message string

+ type EmailChangeResult struct

+ Message string

+ User *User

+ type EmailConfig struct

+ From string

+ Provider string

+ SMTPHost string

+ SMTPPass string

+ SMTPPort int

+ SMTPUser string

type EventBusConfig

+ PubSubType string

+ type EventEmitter interface

+ OnEmailChanged func(user User)

+ OnEmailVerified func(user User)

+ OnPasswordChanged func(user User)

+ OnUserLoggedIn func(user User)

+ OnUserSignedUp func(user User)

type KeyValueStore

+ func (KeyValueStore) TableName() string

+ type Logger interface

+ Debug func(msg string, args ...any)

+ Error func(msg string, args ...any)

+ Info func(msg string, args ...any)

+ Warn func(msg string, args ...any)

+ type LoggerConfig struct

+ Level string

+ Logger Logger

+ type MailerService interface

+ Send func(ctx context.Context, to string, subject string, body string, htmlBody string) error

+ type MeResult struct

+ Session *Session

+ User *User

+ type Mode string

+ const ModeLibrary

+ const ModeStandalone

+ type OAuth2LoginResult struct

+ AuthURL string

+ State string

+ Verifier *string

+ type OAuth2ProviderConfig struct

+ AuthURL string

+ ClientID string

+ ClientSecret string

+ Enabled bool

+ RedirectURL string

+ Scopes []string

+ TokenURL string

+ UserInfoURL string

type OAuth2UserInfo

+ Raw map[string]any

+ type PasswordResetRequestResult struct

+ Message string

+ type PasswordResetResult struct

+ Message string

+ type PasswordService interface

+ HashPassword func(password string) (string, error)

+ VerifyPassword func(password string, hash string) (bool, error)

type Plugin

+ EndpointHooks func() any

+ SetEndpointHooks func(hooks any)

+ SetWebhooks func(hooks any)

+ Webhooks func() any

type PluginContext

+ WebhookExecutor WebhookExecutor

+ type PluginRegistry interface

+ CloseAll func()

+ InitAll func() error

+ Plugins func() []Plugin

+ Register func(p Plugin)

+ RunMigrations func() error

type SecondaryStorage

+ Close func() error

+ type SignInResult struct

+ CSRFToken *string

+ Token string

+ User *User

+ type SignOutResult struct

+ Message string

+ type SignUpResult struct

+ CSRFToken *string

+ Token string

+ User *User

type SocialProvidersConfig

+ Providers map[string]OAuth2ProviderConfig

+ type VerifyEmailResult struct

+ Message string

+ User *User

+ type WebhookConfig struct

+ Headers map[string]string

+ TimeoutSeconds time.Duration

+ URL string

+ type WebhookExecutor interface

+ ExecuteWebhook func(webhook *WebhookConfig, payload any) error

+ type WebhooksConfig struct

+ OnEmailChanged *WebhookConfig

+ OnEmailVerified *WebhookConfig

+ OnPasswordChanged *WebhookConfig

+ OnUserLoggedIn *WebhookConfig

+ OnUserSignedUp *WebhookConfig

v1.3.8

Dec 18, 2025

v1.3.7

Dec 18, 2025

v1.3.6

Dec 18, 2025

Changes in this version

type EndpointHookContext

+ Handled bool

+ Redirect func(url string, status int)

v1.3.5

Dec 17, 2025

v1.3.4

Dec 17, 2025

Changes in this version

+ type BasePlugin struct

+ func (p *BasePlugin) Close() error

+ func (p *BasePlugin) Config() PluginConfig

+ func (p *BasePlugin) Ctx() *PluginContext

+ func (p *BasePlugin) DatabaseHooks() *PluginDatabaseHooks

+ func (p *BasePlugin) EventHooks() *PluginEventHooks

+ func (p *BasePlugin) Init(ctx *PluginContext) error

+ func (p *BasePlugin) Metadata() PluginMetadata

+ func (p *BasePlugin) Migrations() []any

+ func (p *BasePlugin) RateLimit() *PluginRateLimit

+ func (p *BasePlugin) Routes() []PluginRoute

+ func (p *BasePlugin) SetClose(fn func() error)

+ func (p *BasePlugin) SetConfig(cfg PluginConfig)

+ func (p *BasePlugin) SetCtx(ctx *PluginContext)

+ func (p *BasePlugin) SetDatabaseHooks(hooks *PluginDatabaseHooks)

+ func (p *BasePlugin) SetEventHooks(hooks *PluginEventHooks)

+ func (p *BasePlugin) SetInit(fn func(ctx *PluginContext) error)

+ func (p *BasePlugin) SetMetadata(meta PluginMetadata)

+ func (p *BasePlugin) SetMigrations(migrations []any)

+ func (p *BasePlugin) SetRateLimit(rateLimit *PluginRateLimit)

+ func (p *BasePlugin) SetRoutes(routes []PluginRoute)

type Plugin

+ SetClose func(fn func() error)

+ SetConfig func(cfg PluginConfig)

+ SetCtx func(ctx *PluginContext)

+ SetDatabaseHooks func(hooks *PluginDatabaseHooks)

+ SetEventHooks func(hooks *PluginEventHooks)

+ SetInit func(fn func(ctx *PluginContext) error)

+ SetMetadata func(meta PluginMetadata)

+ SetMigrations func(migrations []any)

+ SetRateLimit func(rateLimit *PluginRateLimit)

+ SetRoutes func(routes []PluginRoute)

+ type PluginOption func(p Plugin)

v1.3.2

Dec 16, 2025

v1.3.1

Dec 16, 2025

Changes in this version

type EventBusConfig

+ MaxConcurrentHandlers int

type EventSubscriber

+ Unsubscribe func(eventType string, id SubscriptionID)

+ type SubscriptionID uint64

v1.3.0

Dec 16, 2025

Changes in this version

+ const EventEmailChanged

+ const EventEmailVerified

+ const EventPasswordChanged

+ const EventUserLoggedIn

+ const EventUserSignedUp

+ const RateLimitAlgorithmFixedWindow

+ type Account struct

+ AccessToken *string

+ AccessTokenExpiresAt *time.Time

+ AccountID string

+ CreatedAt time.Time

+ ID string

+ IDToken *string

+ Password *string

+ ProviderID ProviderType

+ RefreshToken *string

+ RefreshTokenExpiresAt *time.Time

+ Scope *string

+ UpdatedAt time.Time

+ User User

+ UserID string

+ type AccountDatabaseHooksConfig struct

+ AfterCreate func(account Account) error

+ AfterUpdate func(account Account) error

+ BeforeCreate func(account *Account) error

+ BeforeUpdate func(account *Account) error

+ type AccountService interface

+ CreateAccount func(account *Account) error

+ GetAccountByProviderAndAccountID func(provider ProviderType, accountID string) (*Account, error)

+ GetAccountByUserID func(userID string) (*Account, error)

+ UpdateAccount func(account *Account) error

+ type AfterCreateHook func(ctx *PluginContext, entity *T) error

+ type AfterDeleteHook func(ctx *PluginContext, entity *T) error

+ type AfterReadHook func(ctx *PluginContext, results *[]T) error

+ type AfterUpdateHook func(ctx *PluginContext, updated *T) error

+ type Api struct

+ Accounts AccountService

+ RateLimit RateLimitService

+ Sessions SessionService

+ Tokens TokenService

+ Users UserService

+ Verifications VerificationService

+ type BeforeCreateHook func(ctx *PluginContext, entity *T) error

+ type BeforeDeleteHook func(ctx *PluginContext, entity *T) error

+ type BeforeReadHook func(ctx *PluginContext) error

+ type BeforeUpdateHook func(ctx *PluginContext, existing *T, updatedData map[string]any) error

+ type CSRFConfig struct

+ CookieName string

+ Enabled bool

+ ExpiresIn time.Duration

+ HeaderName string

+ type ChangeEmailConfig struct

+ Enabled bool

+ SendEmailChangeVerificationEmail func(user User, newEmail string, url string, token string) error

+ type Config struct

+ AppName string

+ BasePath string

+ BaseURL string

+ CSRF CSRFConfig

+ DB *gorm.DB

+ Database DatabaseConfig

+ DatabaseHooks DatabaseHooksConfig

+ EmailPassword EmailPasswordConfig

+ EmailVerification EmailVerificationConfig

+ EndpointHooks EndpointHooksConfig

+ EventBus EventBusConfig

+ EventHooks EventHooksConfig

+ Plugins PluginsConfig

+ RateLimit RateLimitConfig

+ SecondaryStorage SecondaryStorageConfig

+ Secret string

+ Session SessionConfig

+ SocialProviders SocialProvidersConfig

+ TrustedOrigins TrustedOriginsConfig

+ User UserConfig

+ type ConfigOption func(*Config)

+ type CustomRoute struct

+ Handler CustomRouteHandler

+ Method string

+ Middleware []CustomRouteMiddleware

+ Path string

+ type CustomRouteHandler func(config *Config) http.Handler

+ type CustomRouteMiddleware func(http.Handler) http.Handler

+ type DatabaseConfig struct

+ ConnMaxLifetime time.Duration

+ ConnectionString string

+ MaxIdleConns int

+ MaxOpenConns int

+ Provider string

+ type DatabaseHooksConfig struct

+ Accounts *AccountDatabaseHooksConfig

+ Sessions *SessionDatabaseHooksConfig

+ Users *UserDatabaseHooksConfig

+ Verifications *VerificationDatabaseHooksConfig

+ type DefaultOAuth2ProvidersConfig struct

+ Discord *OAuth2Config

+ GitHub *OAuth2Config

+ Google *OAuth2Config

+ type EmailPasswordConfig struct

+ AutoSignIn bool

+ DisableSignUp bool

+ Enabled bool

+ MaxPasswordLength int

+ MinPasswordLength int

+ Password *PasswordConfig

+ RequireEmailVerification bool

+ ResetTokenExpiry time.Duration

+ SendResetPasswordEmail func(user User, url string, token string) error

+ type EmailVerificationConfig struct

+ AutoSignIn bool

+ ExpiresIn time.Duration

+ SendOnSignIn bool

+ SendOnSignUp bool

+ SendVerificationEmail func(user User, url string, token string) error

+ type EndpointHookContext struct

+ Body map[string]any

+ Headers map[string][]string

+ Method string

+ Path string

+ Query map[string][]string

+ Request *http.Request

+ ResponseBody []byte

+ ResponseCookies []*http.Cookie

+ ResponseHeaders map[string][]string

+ ResponseStatus int

+ User *User

+ type EndpointHooksConfig struct

+ After func(ctx *EndpointHookContext) error

+ Before func(ctx *EndpointHookContext) error

+ Response func(ctx *EndpointHookContext) error

+ type Event struct

+ ID string

+ Metadata map[string]string

+ Payload json.RawMessage

+ Timestamp time.Time

+ Type string

+ type EventBus interface

+ type EventBusConfig struct

+ Enabled bool

+ Prefix string

+ PubSub PubSub

+ type EventHandler func(ctx context.Context, event Event) error

+ type EventHooksConfig struct

+ OnEmailChanged func(user User) error

+ OnEmailVerified func(user User) error

+ OnPasswordChanged func(user User) error

+ OnUserLoggedIn func(user User) error

+ OnUserSignedUp func(user User) error

+ type EventPublisher interface

+ Close func() error

+ Publish func(ctx context.Context, event Event) error

+ type EventSubscriber interface

+ Close func() error

+ Subscribe func(ctx context.Context, eventType string, handler EventHandler) error

+ type GenericOAuth2Config struct

+ Endpoint GenericOAuth2EndpointConfig

+ type GenericOAuth2EndpointConfig struct

+ AuthURL string

+ TokenURL string

+ UserInfoURL string

+ type IPConfig struct

+ Headers []string

+ type KeyValueStore struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ Key string

+ UpdatedAt time.Time

+ Value string

+ type Message struct

+ Metadata map[string]string

+ Payload []byte

+ UUID string

+ type OAuth2Config struct

+ ClientID string

+ ClientSecret string

+ RedirectURL string

+ Scopes []string

+ type OAuth2UserInfo struct

+ Email string

+ ID string

+ Name string

+ Picture string

+ Verified bool

+ type PasswordConfig struct

+ Hash func(password string) (string, error)

+ Verify func(hashedPassword, password string) bool

+ type Plugin interface

+ Close func() error

+ Config func() PluginConfig

+ Ctx func() *PluginContext

+ DatabaseHooks func() *PluginDatabaseHooks

+ EventHooks func() *PluginEventHooks

+ Init func(ctx *PluginContext) error

+ Metadata func() PluginMetadata

+ Migrations func() []any

+ RateLimit func() *PluginRateLimit

+ Routes func() []PluginRoute

+ type PluginConfig struct

+ Enabled bool

+ Options PluginOptions

+ type PluginContext struct

+ Api *Api

+ Config *Config

+ EventBus EventBus

+ Middleware *PluginMiddleware

+ type PluginDatabaseHookOperations struct

+ AfterCreate *AfterCreateHook[T]

+ AfterDelete *AfterDeleteHook[T]

+ AfterRead *AfterReadHook[T]

+ AfterUpdate *AfterUpdateHook[T]

+ BeforeCreate *BeforeCreateHook[T]

+ BeforeDelete *BeforeDeleteHook[T]

+ BeforeRead *BeforeReadHook[T]

+ BeforeUpdate *BeforeUpdateHook[T]

+ type PluginDatabaseHooks map[string]PluginDatabaseHookOperations[any]

+ type PluginEventHookFunc func(ctx *PluginContext, payload PluginEventHookPayload) error

+ type PluginEventHookPayload any

+ type PluginEventHooks map[string]PluginEventHookFunc

+ type PluginMetadata struct

+ Description string

+ Name string

+ Version string

+ type PluginMiddleware struct

+ Auth func() func(http.Handler) http.Handler

+ CSRF func() func(http.Handler) http.Handler

+ CorsAuth func() func(http.Handler) http.Handler

+ EndpointHooks func() func(http.Handler) http.Handler

+ OptionalAuth func() func(http.Handler) http.Handler

+ RateLimit func() func(http.Handler) http.Handler

+ type PluginOptions = map[string]any

+ type PluginRateLimit = RateLimitConfig

+ type PluginRoute struct

+ Handler PluginRouteHandler

+ Method string

+ Middleware []PluginRouteMiddleware

+ Path string

+ type PluginRouteHandler func() http.Handler

+ type PluginRouteMiddleware func(http.Handler) http.Handler

+ type PluginsConfig struct

+ Plugins []Plugin

+ type ProviderType string

+ const ProviderDiscord

+ const ProviderEmail

+ const ProviderGitHub

+ const ProviderGoogle

+ type PubSub interface

+ Close func() error

+ Publish func(ctx context.Context, topic string, msg *Message) error

+ Subscribe func(ctx context.Context, topic string) (<-chan *Message, error)

+ type RateLimitConfig struct

+ Algorithm string

+ CustomRules map[string]RateLimitCustomRuleFunc

+ Enabled bool

+ IP IPConfig

+ Max int

+ Prefix string

+ Window time.Duration

+ type RateLimitCustomRule struct

+ Disabled bool

+ Max int

+ Window time.Duration

+ type RateLimitCustomRuleFunc func(req *http.Request) RateLimitCustomRule

+ type RateLimitService interface

+ Allow func(ctx context.Context, key string, req *http.Request) (bool, error)

+ BuildKey func(key string) string

+ GetClientIP func(req *http.Request) string

+ type SecondaryStorage interface

+ Delete func(ctx context.Context, key string) error

+ Get func(ctx context.Context, key string) (any, error)

+ Incr func(ctx context.Context, key string, ttl *time.Duration) (int, error)

+ Set func(ctx context.Context, key string, value any, ttl *time.Duration) error

+ type SecondaryStorageConfig struct

+ DatabaseOptions *SecondaryStorageDatabaseOptions

+ MemoryOptions *SecondaryStorageMemoryOptions

+ Storage SecondaryStorage

+ Type SecondaryStorageType

+ type SecondaryStorageDatabaseOptions struct

+ CleanupInterval time.Duration

+ type SecondaryStorageMemoryOptions struct

+ CleanupInterval time.Duration

+ type SecondaryStorageType string

+ const SecondaryStorageTypeCustom

+ const SecondaryStorageTypeDatabase

+ const SecondaryStorageTypeMemory

+ type Session struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ IPAddress *string

+ Token string

+ UpdatedAt time.Time

+ UserAgent *string

+ UserID string

+ type SessionConfig struct

+ CookieName string

+ ExpiresIn time.Duration

+ UpdateAge time.Duration

+ type SessionDatabaseHooksConfig struct

+ AfterCreate func(session Session) error

+ BeforeCreate func(session *Session) error

+ type SessionService interface

+ CreateSession func(userID string, token string) (*Session, error)

+ DeleteSessionByID func(ID string) error

+ GetSessionByToken func(token string) (*Session, error)

+ GetSessionByUserID func(userID string) (*Session, error)

+ type SocialProvidersConfig struct

+ Default DefaultOAuth2ProvidersConfig

+ Generic map[string]GenericOAuth2Config

+ type TokenService interface

+ DecryptToken func(encryptedToken string) (string, error)

+ EncryptToken func(token string) (string, error)

+ GenerateEncryptedToken func() (string, error)

+ GenerateToken func() (string, error)

+ HashToken func(token string) string

+ type TrustedOriginsConfig struct

+ Origins []string

+ type TypedPluginEventHook func(ctx *PluginContext, payload T) error

+ type User struct

+ CreatedAt time.Time

+ Email string

+ EmailVerified bool

+ ID string

+ Image *string

+ Name string

+ UpdatedAt time.Time

+ type UserConfig struct

+ ChangeEmail ChangeEmailConfig

+ type UserDatabaseHooksConfig struct

+ AfterCreate func(user User) error

+ AfterUpdate func(user User) error

+ BeforeCreate func(user *User) error

+ BeforeUpdate func(user *User) error

+ type UserService interface

+ CreateUser func(user *User) error

+ GetUserByEmail func(email string) (*User, error)

+ GetUserByID func(id string) (*User, error)

+ UpdateUser func(user *User) error

+ type Verification struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ Identifier string

+ Token string

+ Type VerificationType

+ UpdatedAt time.Time

+ UserID *string

+ type VerificationDatabaseHooksConfig struct

+ AfterCreate func(verification Verification) error

+ BeforeCreate func(verification *Verification) error

+ type VerificationService interface

+ CreateVerification func(verif *Verification) error

+ DeleteVerification func(id string) error

+ GetVerificationByToken func(token string) (*Verification, error)

+ IsExpired func(verif *Verification) bool

+ type VerificationType string

+ const TypeEmailChange

+ const TypeEmailVerification

+ const TypePasswordReset

Other modules containing this package

github.com/GoBetterAuth/go-better-auth/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL