types

package
v2.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 6, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangeEmailResponse

type ChangeEmailResponse struct {
	Message string `json:"message"`
}

type ChangePasswordResponse

type ChangePasswordResponse struct {
	Message string `json:"message"`
}

type EmailPasswordPluginConfig

type EmailPasswordPluginConfig struct {
	Enabled                  bool `json:"enabled" toml:"enabled"`
	MinPasswordLength        int  `json:"min_password_length" toml:"min_password_length"`
	MaxPasswordLength        int  `json:"max_password_length" toml:"max_password_length"`
	DisableSignUp            bool `json:"disable_sign_up" toml:"disable_sign_up"`
	RequireEmailVerification bool `json:"require_email_verification" toml:"require_email_verification"`
	// Whether to automatically sign in the user after sign-up
	AutoSignIn                  bool          `json:"auto_sign_in" toml:"auto_sign_in"`
	SendEmailOnSignUp           bool          `json:"send_email_on_sign_up" toml:"send_email_on_sign_up"`
	SendEmailOnSignIn           bool          `json:"send_email_on_sign_in" toml:"send_email_on_sign_in"`
	EmailVerificationExpiresIn  time.Duration `json:"email_verification_expires_in" toml:"email_verification_expires_in"`
	PasswordResetExpiresIn      time.Duration `json:"password_reset_expires_in" toml:"password_reset_expires_in"`
	RequestEmailChangeExpiresIn time.Duration `json:"request_email_change_expires_in" toml:"request_email_change_expires_in"`
	// Function to override sending email verification emails
	SendEmailVerification func(params SendEmailVerificationParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
	// Function to override sending password reset emails
	SendPasswordResetEmail func(params SendPasswordResetEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
	// Function to override sending email change emails
	SendRequestEmailChangeEmail func(params SendRequestEmailChangeEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
}

func (*EmailPasswordPluginConfig) ApplyDefaults

func (config *EmailPasswordPluginConfig) ApplyDefaults()

type SendEmailResetEmailParams

type SendEmailResetEmailParams struct {
	User  models.User
	URL   string
	Token string
}

type SendEmailVerificationParams

type SendEmailVerificationParams struct {
	User  models.User
	URL   string
	Token string
}

type SendPasswordResetEmailParams

type SendPasswordResetEmailParams struct {
	User  models.User
	URL   string
	Token string
}

type SendRequestEmailChangeEmailParams

type SendRequestEmailChangeEmailParams struct {
	User     models.User
	URL      string
	Token    string
	NewEmail string
	OldEmail string
}

type SignInResponse

type SignInResponse struct {
	User    *models.User    `json:"user"`
	Session *models.Session `json:"session"`
}

type SignInResult

type SignInResult struct {
	User         *models.User
	Session      *models.Session
	SessionToken string
}

type SignUpResponse

type SignUpResponse struct {
	User    *models.User    `json:"user"`
	Session *models.Session `json:"session"`
}

type SignUpResult

type SignUpResult struct {
	User         *models.User
	Session      *models.Session
	SessionToken string // Empty string if auto sign-in is disabled
}

Jump to

Keyboard shortcuts

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