auth

Documentation

Index

• Constants
• Variables
• func AskForApiKey() (string, error)
• func AskForUrl(defaultUrl string) (string, error)
• func AskForUserNameAndPassword(userName, password string) (string, string, error)
• func AskIfOpenBrowser() (bool, error)
• func AskIfUseLogin() (bool, error)
• func CheckLoggedIn() error
• func EnvNameFromUrl(url string) string
• func GetWhoami(ctx context.Context) (*tensorleapapi.UserData, error)
• func IsApiBaseUrlSet() bool
• func IsLocalUrl(url string) bool
• func Login(env *Env) (err error)
• func LoginAndGetAuthToken(apiUrl, username, password string) (string, error)
• func LoginAndGetAuthTokenWithBrowser(ctx context.Context, apiUrl string) (string, error)
• func Logout(envName string) error
• func NormalizeAPIUrl(url string) string
• func PrintWhoami(ctx context.Context) error
• func SelectAndSetEnv(envName string) error
• type ApiKeyResponse
• type Env
  • func GetCurrentEnv() *Env
  • func GetEnvAuth(name string) (*Env, error)
  • func GetEnvs() []Env
  • func NewEnv(name, apiUrl, apiKey string) *Env
  • func SelectEnv(msg string, envName string) (*Env, error)
  • func (a *Env) AuthContext(ctx context.Context) context.Context
  • func (a *Env) PrintWhoami(ctx context.Context) error
• type TokenResponse

Constants

const (
	API_URL  = "api_url"
	API_KEY  = "api_key"
	ENV_NAME = "name"

	ENVIRONMENTS_CONFIG_PATH = "envs"
	AUTH_CONFIG_PATH         = "auth"

	CURRENT_ENV = "current_env"
)

const API_PATH = "/api/v2"

Variables

var (
	// just for backward compatibility, will use just current_env and envs in the future
	API_KEY_CONFIG_PATH = getAuthPath(API_KEY)
	API_URL_CONFIG_PATH = getAuthPath(API_URL)
)

var ErrNotLoggedIn = fmt.Errorf("not logged in")

Functions

func AskForApiKey

func AskForApiKey() (string, error)

func AskForUrl

func AskForUrl(defaultUrl string) (string, error)

func AskForUserNameAndPassword

func AskForUserNameAndPassword(userName, password string) (string, string, error)

func AskIfOpenBrowser

func AskIfOpenBrowser() (bool, error)

func AskIfUseLogin

func AskIfUseLogin() (bool, error)

func CheckLoggedIn

func CheckLoggedIn() error

func EnvNameFromUrl

func EnvNameFromUrl(url string) string

func GetWhoami

func GetWhoami(ctx context.Context) (*tensorleapapi.UserData, error)

func IsApiBaseUrlSet

func IsApiBaseUrlSet() bool

func IsLocalUrl

func IsLocalUrl(url string) bool

func Login

func Login(env *Env) (err error)

func LoginAndGetAuthToken

func LoginAndGetAuthToken(apiUrl, username, password string) (string, error)

func LoginAndGetAuthTokenWithBrowser

func LoginAndGetAuthTokenWithBrowser(ctx context.Context, apiUrl string) (string, error)

func Logout

func Logout(envName string) error

func NormalizeAPIUrl

func NormalizeAPIUrl(url string) string

func PrintWhoami

func PrintWhoami(ctx context.Context) error

func SelectAndSetEnv

func SelectAndSetEnv(envName string) error

Types

type ApiKeyResponse

type ApiKeyResponse struct {
	ApiKey string `json:"apiKey"`
}

the response is a json with key apiToken

type Env

type Env struct {
	Name   string
	ApiUrl string
	ApiKey string
}

func GetCurrentEnv

func GetCurrentEnv() *Env

func GetEnvAuth

func GetEnvAuth(name string) (*Env, error)

func GetEnvs

func GetEnvs() []Env

func NewEnv

func NewEnv(name, apiUrl, apiKey string) *Env

func SelectEnv

func SelectEnv(msg string, envName string) (*Env, error)

func (*Env) AuthContext

func (a *Env) AuthContext(ctx context.Context) context.Context

func (*Env) PrintWhoami

func (a *Env) PrintWhoami(ctx context.Context) error

type TokenResponse

type TokenResponse struct {
	AccessToken  string `json:"access_token"`
	TokenType    string `json:"token_type"`
	ExpiresIn    int    `json:"expires_in"`
	RefreshToken string `json:"refresh_token"`
}