clients

Documentation

Overview

This package is a fork from the Community STACKIT Go Client

See: https://github.com/SchwarzIT/community-stackit-go-client

Index

• Constants
• type KeyFlow
  • func (c *KeyFlow) GetAccessToken() (string, error)
  • func (c *KeyFlow) GetConfig() KeyFlowConfig
  • func (c *KeyFlow) GetServiceAccountEmail() string
  • func (c *KeyFlow) GetToken() TokenResponseBody
  • func (c *KeyFlow) Init(cfg *KeyFlowConfig) error
  • func (c *KeyFlow) RoundTrip(req *http.Request) (*http.Response, error)
  • func (c *KeyFlow) SetToken(accessToken, refreshToken string) error
• type KeyFlowConfig
• type NoAuthFlow
  • func (c *NoAuthFlow) GetConfig() NoAuthFlowConfig
  • func (c *NoAuthFlow) Init(_ NoAuthFlowConfig) error
  • func (c *NoAuthFlow) RoundTrip(req *http.Request) (*http.Response, error)
• type NoAuthFlowConfig
• type RetryConfig
  • func NewRetryConfig() *RetryConfig
• type ServiceAccountKeyCredentials
• type ServiceAccountKeyResponse
• type TokenFlow
  • func (c *TokenFlow) GetConfig() TokenFlowConfig
  • func (c *TokenFlow) Init(cfg *TokenFlowConfig) error
  • func (c *TokenFlow) RoundTrip(req *http.Request) (*http.Response, error)
• type TokenFlowConfig
• type TokenResponseBody

Constants

const (
	// Service Account Key Flow
	// Auth flow env variables
	ServiceAccountKey     = "STACKIT_SERVICE_ACCOUNT_KEY"
	PrivateKey            = "STACKIT_PRIVATE_KEY"
	ServiceAccountKeyPath = "STACKIT_SERVICE_ACCOUNT_KEY_PATH"
	PrivateKeyPath        = "STACKIT_PRIVATE_KEY_PATH"
)

const (
	DefaultClientTimeout = time.Minute
)

const (
	// Service Account Token Flow
	// Auth flow env variables
	ServiceAccountToken = "STACKIT_SERVICE_ACCOUNT_TOKEN"
)

Types

type KeyFlow

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

KeyFlow handles auth with SA key

func (*KeyFlow) GetAccessToken

func (c *KeyFlow) GetAccessToken() (string, error)

GetAccessToken returns a short-lived access token and saves the access and refresh tokens in the token field

func (*KeyFlow) GetConfig

func (c *KeyFlow) GetConfig() KeyFlowConfig

GetConfig returns the flow configuration

func (*KeyFlow) GetServiceAccountEmail

func (c *KeyFlow) GetServiceAccountEmail() string

GetServiceAccountEmail returns the service account email

func (*KeyFlow) GetToken

func (c *KeyFlow) GetToken() TokenResponseBody

GetToken returns the token field

func (*KeyFlow) Init

func (c *KeyFlow) Init(cfg *KeyFlowConfig) error

func (*KeyFlow) RoundTrip

func (c *KeyFlow) RoundTrip(req *http.Request) (*http.Response, error)

Roundtrip performs the request

func (*KeyFlow) SetToken

func (c *KeyFlow) SetToken(accessToken, refreshToken string) error

SetToken can be used to set an access and refresh token manually in the client. The other fields in the token field are determined by inspecting the token or setting default values.

type KeyFlowConfig

type KeyFlowConfig struct {
	ServiceAccountKey *ServiceAccountKeyResponse
	PrivateKey        string
	// Deprecated: retry options were removed to reduce complexity of the client. If this functionality is needed, you can provide your own custom HTTP client.
	ClientRetry                   *RetryConfig
	TokenUrl                      string
	BackgroundTokenRefreshContext context.Context // Functionality is enabled if this isn't nil
}

KeyFlowConfig is the flow config

type NoAuthFlow

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

func (*NoAuthFlow) GetConfig

func (c *NoAuthFlow) GetConfig() NoAuthFlowConfig

GetConfig returns the flow configuration

func (*NoAuthFlow) Init

func (c *NoAuthFlow) Init(_ NoAuthFlowConfig) error

func (*NoAuthFlow) RoundTrip

func (c *NoAuthFlow) RoundTrip(req *http.Request) (*http.Response, error)

Roundtrip performs the request

type NoAuthFlowConfig

type NoAuthFlowConfig struct {
	// Deprecated: retry options were removed to reduce complexity of the client. If this functionality is needed, you can provide your own custom HTTP client.
	ClientRetry *RetryConfig
}

NoAuthFlowConfig holds the configuration for the unauthenticated flow

type RetryConfig

type RetryConfig struct {
	MaxRetries       int           // Max retries
	WaitBetweenCalls time.Duration // Time to wait between requests
	RetryTimeout     time.Duration // Max time to re-try
	ClientTimeout    time.Duration // HTTP Client timeout
}

Deprecated: retry options were removed to reduce complexity of the client. If this functionality is needed, you can provide your own custom HTTP client.

func NewRetryConfig

func NewRetryConfig() *RetryConfig

Deprecated: retry options were removed to reduce complexity of the client. If this functionality is needed, you can provide your own custom HTTP client.

type ServiceAccountKeyCredentials

type ServiceAccountKeyCredentials struct {
	Aud        string    `json:"aud"`
	Iss        string    `json:"iss"`
	Kid        string    `json:"kid"`
	PrivateKey *string   `json:"privateKey,omitempty"`
	Sub        uuid.UUID `json:"sub"`
}

type ServiceAccountKeyResponse

type ServiceAccountKeyResponse struct {
	Active       bool                          `json:"active"`
	CreatedAt    time.Time                     `json:"createdAt"`
	Credentials  *ServiceAccountKeyCredentials `json:"credentials"`
	ID           uuid.UUID                     `json:"id"`
	KeyAlgorithm string                        `json:"keyAlgorithm"`
	KeyOrigin    string                        `json:"keyOrigin"`
	KeyType      string                        `json:"keyType"`
	PublicKey    string                        `json:"publicKey"`
	ValidUntil   *time.Time                    `json:"validUntil,omitempty"`
}

ServiceAccountKeyResponse is the API response when creating a new SA key

type TokenFlow

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

TokenFlow handles auth with SA static token

func (*TokenFlow) GetConfig

func (c *TokenFlow) GetConfig() TokenFlowConfig

GetConfig returns the flow configuration

func (*TokenFlow) Init

func (c *TokenFlow) Init(cfg *TokenFlowConfig) error

func (*TokenFlow) RoundTrip

func (c *TokenFlow) RoundTrip(req *http.Request) (*http.Response, error)

Roundtrip performs the request

type TokenFlowConfig

type TokenFlowConfig struct {
	ServiceAccountEmail string
	ServiceAccountToken string
	// Deprecated: retry options were removed to reduce complexity of the client. If this functionality is needed, you can provide your own custom HTTP client.
	ClientRetry *RetryConfig
}

TokenFlowConfig is the flow config

type TokenResponseBody

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

TokenResponseBody is the API response when requesting a new token