Versions in this module Expand all Collapse all v0 v0.1.1 Nov 12, 2026 v0.1.0 Oct 14, 2026 Changes in this version + const ColCreatedAt + const ColCreatedBy + const ColEmail + const ColExpiresAt + const ColID + const ColMaxUses + const ColRole + const ColStatus + const ColTokenHash + const ColUseAt + const ColUseInvite + const ColUseUser + const ColUses + const CookieName + const DefaultCookieTTL + const DefaultPage + const DefaultTTL + const EndpointActivate + const EndpointCancel + const EndpointCreate + const EndpointGet + const EndpointList + const EndpointReject + const InviteHeader + const MaxListLimit + const MaxTTL + const PluginName + const PurposeInvite + const TableAliasInvite + const TableAliasUse + const TableNameInvite + const TableNameUse + var ErrBadTTL = errors.New(...) + var ErrForbidden = auth.NewError("invite.forbidden", http.StatusForbidden, "You cannot create this invitation.") + var ErrInvalid = auth.NewError("invite.invalid", http.StatusBadRequest, ...) + var ErrNoBase = errors.New("invite: links need auth.WithBaseURL or invite.Links") + var ErrNoEmail = errors.New(...) + var ErrRequired = auth.NewError("invite.required", http.StatusForbidden, ...) + var InviteCreatedAt = sqlb.Col[time.Time](TableInvite, ColCreatedAt) + var InviteCreatedBy = sqlb.Col[string](TableInvite, ColCreatedBy) + var InviteEmail = sqlb.Col[*string](TableInvite, ColEmail) + var InviteExpiresAt = sqlb.Col[time.Time](TableInvite, ColExpiresAt) + var InviteID = sqlb.Col[string](TableInvite, ColID) + var InviteMaxUses = sqlb.Col[int64](TableInvite, ColMaxUses) + var InviteRole = sqlb.Col[string](TableInvite, ColRole) + var InviteStatus = sqlb.Col[Status](TableInvite, ColStatus) + var InviteTokenHash = sqlb.Col[[]byte](TableInvite, ColTokenHash) + var InviteUses = sqlb.Col[int64](TableInvite, ColUses) + var TableInvite = sqlb.Table + var TableUse = sqlb.Table + var UseAt = sqlb.Col[time.Time](TableUse, ColUseAt) + var UseInviteID = sqlb.Col[string](TableUse, ColUseInvite) + var UseUserID = sqlb.Col[string](TableUse, ColUseUser) + func DefaultText(inviter, link string) string + type Accepted struct + CreatedBy string + InviteID string + NewAccount bool + Role string + UserID string + type Action string + const ActionAccepted + const ActionSignInRequired + type ActivateResult struct + Action Action + type Created struct + ExpiresAt time.Time + ID string + Token auth.WireToken + URL string + type IDRequest struct + ID string + type Invite struct + CreatedAt time.Time + Email string + ExpiresAt time.Time + ID string + MaxUses int64 + Role string + Status Status + Uses int64 + type ListRequest struct + Limit int + Offset int + type ListResult struct + Invites []Invite + Total int64 + type Option func(*Plugin) + func CanCreate(fn func(ctx context.Context, inviter auth.User, in Request) error) Option + func HideInviter() Option + func Links(fn func(t auth.Token) string) Option + func OnAccepted(fn func(ctx context.Context, a Accepted) error) Option + func PublicOnly() Option + func Required() Option + func WithCookieTTL(d time.Duration) Option + func WithTTL(d time.Duration) Option + type Plugin struct + func New(opts ...Option) *Plugin + func (p *Plugin) Activate(ctx context.Context, tok auth.Token) (ActivateResult, error) + func (p *Plugin) Cancel(ctx context.Context, id string) error + func (p *Plugin) Create(ctx context.Context, in Request) (Created, error) + func (p *Plugin) DataHooks() auth.DataHooks + func (p *Plugin) Get(ctx context.Context, tok auth.Token) (View, error) + func (p *Plugin) Init(a *auth.Auth) error + func (p *Plugin) List(ctx context.Context, in ListRequest) (ListResult, error) + func (p *Plugin) Name() string + func (p *Plugin) Operations() []auth.Operation + func (p *Plugin) OptionErr() error + func (p *Plugin) RateLimits() []auth.RateRule + func (p *Plugin) Reject(ctx context.Context, tok auth.Token) error + func (p *Plugin) Tables() []sqlb.Table + func (p *Plugin) TypedMigrations(engine string, t auth.SQLTypes) ([]auth.Migration, error) + func (p *Plugin) UserTables() []auth.UserTable + func (p *Plugin) Validate(c *auth.Config) error + type Request struct + Email string + ExpiresIn int64 + MaxUses int64 + Role string + type Status string + const StatusCanceled + const StatusPending + const StatusRejected + const StatusUsed + type TokenRequest struct + Token auth.WireToken + type View struct + ExpiresAt time.Time + InviterName string + Private bool + Role string + Status Status