config

Documentation

Overview

Package config parses config and plugin configuration files. It provides APIs to read and write config files and manage multiple profiles.

Index

• Constants
• type AuthConfig
• type AuthenticatorPluginConfig
• type Config
  • func (c Config) ClientId() string
  • func (c Config) ClientSecret() string
  • func (c Config) ConfigureCredentialsAuth(clientId string, clientSecret string) bool
  • func (c Config) ConfigureLoginAuth(clientId string, redirectUri string, scopes string) bool
  • func (c *Config) ConfigureOrgTenant(organization string, tenant string) bool
  • func (c Config) ConfigurePatAuth(pat string) bool
  • func (c Config) Pat() string
  • func (c Config) RedirectUri() string
  • func (c Config) Scopes() string
• type ConfigProvider
  • func (cp ConfigProvider) Config(name string) *Config
  • func (cp *ConfigProvider) Load() error
  • func (cp ConfigProvider) New() Config
  • func (cp *ConfigProvider) Update(profileName string, config Config) error
• type ConfigStore
  • func (s ConfigStore) Read() ([]byte, error)
  • func (s ConfigStore) Write(data []byte) error
• type PluginConfig
• type PluginConfigProvider
  • func NewPluginConfigProvider(store PluginConfigStore) *PluginConfigProvider
  • func (cp PluginConfigProvider) Config() PluginConfig
  • func (cp *PluginConfigProvider) Load() error
• type PluginConfigStore
  • func NewPluginConfigStore(filePath string) *PluginConfigStore
  • func (s PluginConfigStore) Read() ([]byte, error)

Constants

const DefaultProfile = "default"

Types

type AuthConfig

type AuthConfig struct {
	Type   string
	Config map[string]interface{}
}

AuthConfig with metadata used for authenticating the caller.

type AuthenticatorPluginConfig

type AuthenticatorPluginConfig struct {
	Name string
	Path string
}

AuthenticatorPluginConfig holds the information about how to execute the external authenticator. The Path to the external authenticator executable

type Config

type Config struct {
	Uri          *url.URL
	Organization string
	Tenant       string
	Path         map[string]string
	Query        map[string]string
	Header       map[string]string
	Auth         AuthConfig
	Insecure     bool
	Debug        bool
	Output       string
}

The Config structure holds the config data from the selected profile.

func (Config) ClientId

func (c Config) ClientId() string

func (Config) ClientSecret

func (c Config) ClientSecret() string

func (Config) ConfigureCredentialsAuth

func (c Config) ConfigureCredentialsAuth(clientId string, clientSecret string) bool

func (Config) ConfigureLoginAuth

func (c Config) ConfigureLoginAuth(clientId string, redirectUri string, scopes string) bool

func (*Config) ConfigureOrgTenant

func (c *Config) ConfigureOrgTenant(organization string, tenant string) bool

func (Config) ConfigurePatAuth

func (c Config) ConfigurePatAuth(pat string) bool

func (Config) Pat

func (c Config) Pat() string

func (Config) RedirectUri

func (c Config) RedirectUri() string

func (Config) Scopes

func (c Config) Scopes() string

type ConfigProvider

type ConfigProvider struct {
	ConfigStore ConfigStore
	// contains filtered or unexported fields
}

ConfigProvider parses the config file with the profiles.

func (ConfigProvider) Config

func (cp ConfigProvider) Config(name string) *Config

func (*ConfigProvider) Load

func (cp *ConfigProvider) Load() error

func (ConfigProvider) New

func (cp ConfigProvider) New() Config

func (*ConfigProvider) Update

func (cp *ConfigProvider) Update(profileName string, config Config) error

type ConfigStore

type ConfigStore struct {
	Config     []byte
	ConfigFile string
}

ConfigStore reads and writes the configuration file

func (ConfigStore) Read

func (s ConfigStore) Read() ([]byte, error)

func (ConfigStore) Write

func (s ConfigStore) Write(data []byte) error

type PluginConfig

type PluginConfig struct {
	Authenticators []AuthenticatorPluginConfig
}

PluginConfig keeps metadata about the configured plugins.

Currently supports only external authenticators. Example: https://github.com/UiPath/uipathcli-authenticator-k8s

type PluginConfigProvider

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

PluginConfigProvider parses the plugin configuration file

func NewPluginConfigProvider

func NewPluginConfigProvider(store PluginConfigStore) *PluginConfigProvider

func (PluginConfigProvider) Config

func (cp PluginConfigProvider) Config() PluginConfig

func (*PluginConfigProvider) Load

func (cp *PluginConfigProvider) Load() error

type PluginConfigStore

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

PluginConfigStore reads the plugin configuration file

func NewPluginConfigStore

func NewPluginConfigStore(filePath string) *PluginConfigStore

func (PluginConfigStore) Read

func (s PluginConfigStore) Read() ([]byte, error)