systemdefaults

Documentation

Index

• type Channels
• type DomainVerification
• type Endpoints
• type KeyConfig
• type MultifactorConfig
• type Notifications
• type OTPConfig
• type SecretGenerators
• type SystemDefaults
• type TemplateData
• type VerificationLifetimes
• type WebAuthN
• type ZitadelDocs

Types

type Channels

type Channels struct {
	Chat       chat.ChatConfig
	Email      smtp.EmailConfig
	Twilio     twilio.TwilioConfig
	FileSystem fs.FSConfig
	Log        log.LogConfig
}

type DomainVerification

type DomainVerification struct {
	VerificationKey       *crypto.KeyConfig
	VerificationGenerator crypto.GeneratorConfig
}

type Endpoints

type Endpoints struct {
	InitCode                 string
	PasswordReset            string
	VerifyEmail              string
	DomainClaimed            string
	PasswordlessRegistration string
}

type KeyConfig

type KeyConfig struct {
	Size                     int
	PrivateKeyLifetime       types.Duration
	PublicKeyLifetime        types.Duration
	EncryptionConfig         *crypto.KeyConfig
	SigningKeyRotationCheck  types.Duration
	SigningKeyGracefulPeriod types.Duration
}

type MultifactorConfig

type MultifactorConfig struct {
	OTP OTPConfig
}

type Notifications

type Notifications struct {
	DebugMode    bool
	Endpoints    Endpoints
	Providers    Channels
	TemplateData TemplateData
}

type OTPConfig

type OTPConfig struct {
	Issuer          string
	VerificationKey *crypto.KeyConfig
}

type SecretGenerators

type SecretGenerators struct {
	PasswordSaltCost         int
	ClientSecretGenerator    crypto.GeneratorConfig
	InitializeUserCode       crypto.GeneratorConfig
	EmailVerificationCode    crypto.GeneratorConfig
	PhoneVerificationCode    crypto.GeneratorConfig
	PasswordVerificationCode crypto.GeneratorConfig
	PasswordlessInitCode     crypto.GeneratorConfig
	MachineKeySize           uint32
	ApplicationKeySize       uint32
}

type SystemDefaults

type SystemDefaults struct {
	DefaultLanguage          language.Tag
	Domain                   string
	ZitadelDocs              ZitadelDocs
	SecretGenerators         SecretGenerators
	UserVerificationKey      *crypto.KeyConfig
	IDPConfigVerificationKey *crypto.KeyConfig
	Multifactors             MultifactorConfig
	VerificationLifetimes    VerificationLifetimes
	DomainVerification       DomainVerification
	IamID                    string
	Notifications            Notifications
	WebAuthN                 WebAuthN
	KeyConfig                KeyConfig
}

type TemplateData

type TemplateData struct {
	InitCode      templates.TemplateData
	PasswordReset templates.TemplateData
	VerifyEmail   templates.TemplateData
	VerifyPhone   templates.TemplateData
	DomainClaimed templates.TemplateData
}

type VerificationLifetimes

type VerificationLifetimes struct {
	PasswordCheck      types.Duration
	ExternalLoginCheck types.Duration
	MFAInitSkip        types.Duration
	SecondFactorCheck  types.Duration
	MultiFactorCheck   types.Duration
}

type WebAuthN

type WebAuthN struct {
	ID            string
	OriginLogin   string
	OriginConsole string
	DisplayName   string
}

type ZitadelDocs

type ZitadelDocs struct {
	Issuer            string
	DiscoveryEndpoint string
}