controlplane

Documentation

Index

• Constants
• func GetCachePath() (string, error)
• func GetPersistedServiceInfo() (settings.ServiceInfo, error)
• func InvokePageRequests[T any](ctx context.Context, uri string, limit int, warnIfTruncated bool) error
• func InvokeRequest(ctx context.Context, method string, relativeUri string, input interface{}, ...) (*http.Response, error)
• func InvokeRequestWithHeaders(ctx context.Context, method string, relativeUri string, input interface{}, ...) (*http.Response, error)
• func Login(ctx context.Context, options LoginConfig) (context.Context, settings.ServiceInfo, error)
• func Logout() error
• type LoginConfig

Constants

const (
	CacheFileEnvVarName = "TYGER_CACHE_FILE"
)

Functions

func GetCachePath

func GetCachePath() (string, error)

func GetPersistedServiceInfo

func GetPersistedServiceInfo() (settings.ServiceInfo, error)

func InvokePageRequests

func InvokePageRequests[T any](ctx context.Context, uri string, limit int, warnIfTruncated bool) error

func InvokeRequest

func InvokeRequest(ctx context.Context, method string, relativeUri string, input interface{}, output interface{}) (*http.Response, error)

func InvokeRequestWithHeaders

func InvokeRequestWithHeaders(ctx context.Context, method string, relativeUri string, input interface{}, output interface{}, headers http.Header) (*http.Response, error)

func Login

func Login(ctx context.Context, options LoginConfig) (context.Context, settings.ServiceInfo, error)

func Logout

func Logout() error

Types

type LoginConfig

type LoginConfig struct {
	ServerUri                       string `json:"serverUri"`
	ServicePrincipal                string `json:"servicePrincipal,omitempty"`
	CertificatePath                 string `json:"certificatePath,omitempty"`
	CertificateThumbprint           string `json:"certificateThumbprint,omitempty"`
	Proxy                           string `json:"proxy,omitempty"`
	DisableTlsCertificateValidation bool   `json:"disableTlsCertificateValidation,omitempty"`

	// These are options for tyger-proxy that are ignored here but we don't want unmarshal to fail if present
	Port               int      `json:"port,omitempty"`
	AllowedClientCIDRs []string `json:"allowedClientCIDRs,omitempty"`
	LogPath            string   `json:"logPath,omitempty"`

	UseDeviceCode bool `json:"-"`
	Persisted     bool `json:"-"`
}