auth

Documentation

Index

• type Config
  • func GetConfig(opts ...Option) (*Config, error)
  • func (c *Config) GetEmail() string
  • func (c *Config) GetPassword() string
  • func (c *Config) GetTokenStorageFilePath() string
  • func (c *Config) ShouldTryOpeningBrowser() bool
  • func (c *Config) ShouldUseLegacyAuthentication() bool
  • func (c *Config) ShouldWriteTokensToDisk() bool
• type Option
  • func WithLegacyCredentials(email, password string) Option
  • func WithOpenBrowser(enabled bool) Option
  • func WithTokenStorageFilePath(filePath string) Option
  • func WithTokenWriting(enabled bool) Option

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config represents authentication configuration.

func GetConfig

func GetConfig(opts ...Option) (*Config, error)

GetConfig returns a configuration object populated with the given options.

func (*Config) GetEmail

func (c *Config) GetEmail() string

GetEmail is the getter for the email.

func (*Config) GetPassword

func (c *Config) GetPassword() string

GetEmail is the getter for the password.

func (*Config) GetTokenStorageFilePath

func (c *Config) GetTokenStorageFilePath() string

GetTokenStorageFilePath is the getter for the token storage file path.

func (*Config) ShouldTryOpeningBrowser

func (c *Config) ShouldTryOpeningBrowser() bool

ShouldTryOpeningBrowser is the getter for the disabled browser boolean.

func (*Config) ShouldUseLegacyAuthentication

func (c *Config) ShouldUseLegacyAuthentication() bool

ShouldUseLegacyAuthentication is the getter for the legacy (programmatic) authentication boolean.

func (*Config) ShouldWriteTokensToDisk

func (c *Config) ShouldWriteTokensToDisk() bool

ShouldWriteTokensToDisk is the getter for the token writing disabled boolean.

type Option

type Option func(*Config)

Option represents an authentication option

func WithLegacyCredentials

func WithLegacyCredentials(email, password string) Option

WithLegacyCredentials is the authentication option to set legacy credentials.

func WithOpenBrowser

func WithOpenBrowser(enabled bool) Option

WithOpenBrowser is the authentication option to toggle whether the browser should be opened for the device authorization flow URL.

func WithTokenStorageFilePath

func WithTokenStorageFilePath(filePath string) Option

WithTokenStorageFilePath is the authentication option to set the token storage file path.

func WithTokenWriting

func WithTokenWriting(enabled bool) Option

WithTokenWritingDisabled is the authentication option to toggle whether tokens acquired through the device authorization flow should be written to disk.