auth

Documentation

Index

• func ConfigurationFields(providerType string) []object.ProviderConfigurationField
• func GetAuthTypes() []string
• type Provider
  • func GetAuthProvider(provider object.Provider) (Provider, error)
• type ProviderContext

Functions

func ConfigurationFields

func ConfigurationFields(providerType string) []object.ProviderConfigurationField

func GetAuthTypes

func GetAuthTypes() []string

Types

type Provider

type Provider interface {
	GetConfigurationFields() []object.ProviderConfigurationField
	ValidateConfigurationFields() error
	// Configure is used for set up a new credential object. It returns the finished metadata which can be saved.
	Configure(ctx context.Context, providerContext ProviderContext, data map[string]any) (map[string]any, error)
	Validate(ctx context.Context, providerContext ProviderContext, data map[string]any) (bool, map[string]any, error)
	Begin(ctx context.Context, providerContext ProviderContext) (map[string]any, error)
	Submit(ctx context.Context, providerContext ProviderContext, data map[string]any) (bool, error)
}

func GetAuthProvider

func GetAuthProvider(provider object.Provider) (Provider, error)

type ProviderContext

type ProviderContext struct {
	Tenant     object.Tenant
	User       object.User
	Credential object.Credentials

	SendMail func(ctx context.Context, data object.SendMailData)
}