types

Documentation

Index

• type MagicLinkExchangeRequest
  • func (r *MagicLinkExchangeRequest) Validate() error
• type MagicLinkExchangeResponse
• type MagicLinkExchangeResult
• type MagicLinkPluginConfig
  • func (config *MagicLinkPluginConfig) ApplyDefaults()
• type MagicLinkSignInContext
• type MagicLinkSignInRequest
  • func (r *MagicLinkSignInRequest) Validate() error
• type MagicLinkSignInResponse
• type MagicLinkSignInResult
• type MagicLinkVerifyRequest
  • func (r *MagicLinkVerifyRequest) Validate() error
• type MagicLinkVerifyResponse
• type SendMagicLinkVerificationEmailParams

Types

type MagicLinkExchangeRequest

type MagicLinkExchangeRequest struct {
	Token string `json:"token" required:"true" nullable:"false"`
}

func (*MagicLinkExchangeRequest) Validate

func (r *MagicLinkExchangeRequest) Validate() error

type MagicLinkExchangeResponse

type MagicLinkExchangeResponse struct {
	User    *models.User    `json:"user" required:"true" nullable:"false"`
	Session *models.Session `json:"session" required:"true" nullable:"false"`
}

type MagicLinkExchangeResult

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

type MagicLinkPluginConfig

type MagicLinkPluginConfig struct {
	Enabled       bool          `json:"enabled" toml:"enabled"`
	ExpiresIn     time.Duration `json:"expires_in" toml:"expires_in"`
	DisableSignUp bool          `json:"disable_sign_up" toml:"disable_sign_up"`

	SendMagicLinkVerificationEmail func(params SendMagicLinkVerificationEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
}

func (*MagicLinkPluginConfig) ApplyDefaults

func (config *MagicLinkPluginConfig) ApplyDefaults()

type MagicLinkSignInContext

type MagicLinkSignInContext struct {
	emailtmpl.CommonContext
	UserEmail string
	MagicLink string
	Expiry    time.Duration
}

type MagicLinkSignInRequest

type MagicLinkSignInRequest struct {
	Email       string  `json:"email" required:"true" nullable:"false"`
	Name        *string `json:"name,omitempty" nullable:"true"`
	CallbackURL *string `json:"callback_url,omitempty" nullable:"true"`
}

func (*MagicLinkSignInRequest) Validate

func (r *MagicLinkSignInRequest) Validate() error

type MagicLinkSignInResponse

type MagicLinkSignInResponse struct {
	Message string `json:"message" required:"true" nullable:"false"`
}

type MagicLinkSignInResult

type MagicLinkSignInResult struct {
	Token string
}

type MagicLinkVerifyRequest

type MagicLinkVerifyRequest struct {
	Token       string `query:"token" json:"token" required:"true" nullable:"false"`
	CallbackURL string `query:"callback_url" json:"callback_url,omitempty" nullable:"true"`
}

func (*MagicLinkVerifyRequest) Validate

func (r *MagicLinkVerifyRequest) Validate() error

type MagicLinkVerifyResponse

type MagicLinkVerifyResponse struct {
	Message string `json:"message" required:"true" nullable:"false"`
	Token   string `json:"token,omitempty" nullable:"false"`
}

type SendMagicLinkVerificationEmailParams

type SendMagicLinkVerificationEmailParams struct {
	Email string
	URL   string
	Token string
}