options

package
v2.0.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Lookup

type Lookup map[string]*Options

Lookup is a map of Options keyed by Options Name

func (Lookup) Validate

func (l Lookup) Validate(f types.IsRegisteredFunc) error

type Options

type Options struct {
	Name            string                      `yaml:"-"` // populated from the Lookup key
	Provider        types.Provider              `yaml:"provider"`
	ObserveOnly     bool                        `yaml:"observe_only"`
	ProxyPreserve   bool                        `yaml:"proxy_preserve"`
	UsersFile       string                      `yaml:"users_file"`
	UsersFileFormat types.CredentialsFileFormat `yaml:"users_file_format"`
	Users           ct.EnvStringMap             `yaml:"users,omitempty"`
	ProviderData    map[string]any              `yaml:"config"`
	Authenticator   types.Authenticator         `yaml:"-"`
}

func New

func New() *Options

New returns a new Authenticator Options with default values

func (*Options) Clone

func (o *Options) Clone() *Options

func (*Options) Initialize

func (o *Options) Initialize() error

func (*Options) UnmarshalYAML

func (o *Options) UnmarshalYAML(unmarshal func(any) error) error

func (*Options) Validate

func (o *Options) Validate(f types.IsRegisteredFunc) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL