Documentation
¶
Index ¶
- type ChangeEmailResponse
- type ChangePasswordRequest
- type ChangePasswordResponse
- type EmailPasswordPluginConfig
- type RequestEmailChangeRequest
- type RequestPasswordResetRequest
- type SendChangedEmailToNewEmailParams
- type SendChangedEmailToOldEmailParams
- type SendChangedPasswordEmailParams
- type SendEmailResetEmailParams
- type SendEmailVerificationParams
- type SendEmailVerificationRequest
- type SendPasswordResetEmailParams
- type SendRequestEmailChangeEmailParams
- type SignInRequest
- type SignInResponse
- type SignInResult
- type SignUpRequest
- type SignUpResponse
- type SignUpResult
- type VerifyEmailRequest
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 ChangePasswordRequest ¶ added in v1.2.0
func (*ChangePasswordRequest) Validate ¶ added in v1.2.0
func (p *ChangePasswordRequest) Validate() error
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"`
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"`
SendEmailVerification func(params SendEmailVerificationParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
SendPasswordResetEmail func(params SendPasswordResetEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
SendChangedPasswordEmail func(params SendChangedPasswordEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
SendRequestEmailChangeEmail func(params SendRequestEmailChangeEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
SendChangedEmailToOldEmail func(params SendChangedEmailToOldEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
SendChangedEmailToNewEmail func(params SendChangedEmailToNewEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
}
func (*EmailPasswordPluginConfig) ApplyDefaults ¶
func (config *EmailPasswordPluginConfig) ApplyDefaults()
type RequestEmailChangeRequest ¶ added in v1.2.0
type RequestEmailChangeRequest struct {
NewEmail string `json:"new_email"`
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*RequestEmailChangeRequest) Validate ¶ added in v1.2.0
func (p *RequestEmailChangeRequest) Validate() error
type RequestPasswordResetRequest ¶ added in v1.2.0
type RequestPasswordResetRequest struct {
Email string `json:"email"`
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*RequestPasswordResetRequest) Validate ¶ added in v1.2.0
func (p *RequestPasswordResetRequest) Validate() error
type SendChangedEmailToNewEmailParams ¶ added in v1.5.0
type SendChangedEmailToOldEmailParams ¶ added in v1.5.0
type SendChangedPasswordEmailParams ¶ added in v1.5.0
type SendEmailVerificationRequest ¶ added in v1.2.0
type SendEmailVerificationRequest struct {
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*SendEmailVerificationRequest) Validate ¶ added in v1.2.0
func (p *SendEmailVerificationRequest) Validate() error
type SignInRequest ¶ added in v1.2.0
type SignInRequest struct {
Email string `json:"email"`
Password string `json:"password"`
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*SignInRequest) Validate ¶ added in v1.2.0
func (p *SignInRequest) Validate() error
type SignInResponse ¶
type SignInResult ¶
type SignUpRequest ¶ added in v1.2.0
type SignUpRequest struct {
Name string `json:"name"`
Email string `json:"email"`
Password string `json:"password"`
Image *string `json:"image,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"`
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*SignUpRequest) Validate ¶ added in v1.2.0
func (p *SignUpRequest) Validate() error
type SignUpResponse ¶
type SignUpResult ¶
type VerifyEmailRequest ¶ added in v1.2.0
type VerifyEmailRequest struct {
Token string `json:"token"`
CallbackURL *string `json:"callback_url,omitempty"`
}
func (*VerifyEmailRequest) Validate ¶ added in v1.2.0
func (p *VerifyEmailRequest) Validate() error
Click to show internal directories.
Click to hide internal directories.