api

Documentation

Index

• type AcquireTokenResult
• type Client
  • func NewClient(cfg Config) (Client, error)
  • func (c Client) AcquireToken(tokenUrl string) (*AcquireTokenResult, error)
  • func (c Client) GetDebugConnectionInfo(debugKey string) (DebugConnectionInfo, error)
  • func (c Client) GetLeafVersions() (*LeafVersionsResult, error)
  • func (c Client) InitiateRun(cfg InitiateRunConfig) (*InitiateRunResult, error)
  • func (c Client) ObtainAuthCode(cfg ObtainAuthCodeConfig) (*ObtainAuthCodeResult, error)
  • func (c Client) SetSecretsInVault(cfg SetSecretsInVaultConfig) (*SetSecretsInVaultResult, error)
  • func (c Client) Whoami() (*WhoamiResult, error)
• type Config
  • func (c Config) Validate() error
• type DebugConnectionInfo
• type DebugConnectionInfoError
• type InitializationParameter
• type InitiateRunConfig
  • func (c InitiateRunConfig) Validate() error
• type InitiateRunResult
• type LeafVersionsResult
• type ObtainAuthCodeCode
• type ObtainAuthCodeConfig
  • func (c ObtainAuthCodeConfig) Validate() error
• type ObtainAuthCodeResult
• type Secret
• type SetSecretsInVaultConfig
• type SetSecretsInVaultResult
• type TaskDefinition
• type WhoamiResult

Types

type AcquireTokenResult

type AcquireTokenResult struct {
	State string `json:"state"` // consumed, expired, authorized, pending
	Token string `json:"token,omitempty"`
}

type Client

type Client struct {
	RoundTrip func(*http.Request) (*http.Response, error)
}

Client is an API Client for Mint

func NewClient

func NewClient(cfg Config) (Client, error)

func (Client) AcquireToken

func (c Client) AcquireToken(tokenUrl string) (*AcquireTokenResult, error)

AcquireToken consumes the one-time-use code once authorized

func (Client) GetDebugConnectionInfo

func (c Client) GetDebugConnectionInfo(debugKey string) (DebugConnectionInfo, error)

func (Client) GetLeafVersions

func (c Client) GetLeafVersions() (*LeafVersionsResult, error)

func (Client) InitiateRun

func (c Client) InitiateRun(cfg InitiateRunConfig) (*InitiateRunResult, error)

InitiateRun sends a request to Mint for starting a new run

func (Client) ObtainAuthCode

func (c Client) ObtainAuthCode(cfg ObtainAuthCodeConfig) (*ObtainAuthCodeResult, error)

ObtainAuthCode requests a new one-time-use code to login on a device

func (Client) SetSecretsInVault

func (c Client) SetSecretsInVault(cfg SetSecretsInVaultConfig) (*SetSecretsInVaultResult, error)

func (Client) Whoami

func (c Client) Whoami() (*WhoamiResult, error)

Whoami provides details about the authenticated token

type Config

type Config struct {
	Host               string
	AccessToken        string
	AccessTokenBackend accesstoken.Backend
}

func (Config) Validate

func (c Config) Validate() error

type DebugConnectionInfo

type DebugConnectionInfo struct {
	Address        string
	PublicHostKey  string `json:"public_host_key"`
	PrivateUserKey string `json:"private_user_key"`
}

type DebugConnectionInfoError

type DebugConnectionInfoError struct {
	Error string
}

type InitializationParameter

type InitializationParameter struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type InitiateRunConfig

type InitiateRunConfig struct {
	InitializationParameters []InitializationParameter `json:"initialization_parameters"`
	TaskDefinitions          []TaskDefinition          `json:"task_definitions"`
	MintDirectory            []TaskDefinition          `json:"mint_directory"`
	TargetedTaskKeys         []string                  `json:"targeted_task_keys,omitempty"`
	Title                    string                    `json:"title,omitempty"`
	UseCache                 bool                      `json:"use_cache"`
}

func (InitiateRunConfig) Validate

func (c InitiateRunConfig) Validate() error

type InitiateRunResult

type InitiateRunResult struct {
	RunId            string
	RunURL           string
	TargetedTaskKeys []string
	DefinitionPath   string
}

type LeafVersionsResult

type LeafVersionsResult struct {
	LatestMajor map[string]string            `json:"latest_major"`
	LatestMinor map[string]map[string]string `json:"latest_minor"`
}

type ObtainAuthCodeCode

type ObtainAuthCodeCode struct {
	DeviceName string `json:"device_name"`
}

type ObtainAuthCodeConfig

type ObtainAuthCodeConfig struct {
	Code ObtainAuthCodeCode `json:"code"`
}

func (ObtainAuthCodeConfig) Validate

func (c ObtainAuthCodeConfig) Validate() error

type ObtainAuthCodeResult

type ObtainAuthCodeResult struct {
	AuthorizationUrl string `json:"authorization_url"`
	TokenUrl         string `json:"token_url"`
}

type Secret

type Secret struct {
	Name   string `json:"name"`
	Secret string `json:"secret"`
}

type SetSecretsInVaultConfig

type SetSecretsInVaultConfig struct {
	Secrets   []Secret `json:"secrets"`
	VaultName string   `json:"vault_name"`
}

type SetSecretsInVaultResult

type SetSecretsInVaultResult struct {
	SetSecrets []string `json:"set_secrets"`
}

type TaskDefinition

type TaskDefinition struct {
	Path         string `json:"path"`
	FileContents string `json:"file_contents"` // This type is expected by cloud
}

type WhoamiResult

type WhoamiResult struct {
	OrganizationSlug string  `json:"organization_slug"`
	TokenKind        string  `json:"token_kind"` // organization_access_token, personal_access_token
	UserEmail        *string `json:"user_email,omitempty"`
}