auth

Documentation

Index

• func BuildClientOptions(workspace string, credentials blaxel.Credentials) []option.RequestOption
• func ListWorkspaces(credentials blaxel.Credentials) ([]blaxel.Workspace, error)
• func LoginApiKey(workspace string)
• func LoginClientCredentials(workspace string, clientCredentials string)
• func LoginDevice(workspace string)
• func ResetClientFactory()
• func SetClientFactory(factory ClientFactory)
• func ValidateWorkspace(workspace string, credentials blaxel.Credentials) error
• type AuthErrorResponse
• type ClientFactory
• type DeviceLogin
• type DeviceLoginFinalizeRequest
• type DeviceLoginFinalizeResponse
• type DeviceLoginResponse
• type WorkspaceLister

Functions

func BuildClientOptions

func BuildClientOptions(workspace string, credentials blaxel.Credentials) []option.RequestOption

BuildClientOptions builds request options from credentials

func ListWorkspaces

func ListWorkspaces(credentials blaxel.Credentials) ([]blaxel.Workspace, error)

ListWorkspaces lists all workspaces for the given credentials

func LoginApiKey

func LoginApiKey(workspace string)

func LoginClientCredentials

func LoginClientCredentials(workspace string, clientCredentials string)

func LoginDevice

func LoginDevice(workspace string)

func ResetClientFactory

func ResetClientFactory()

ResetClientFactory resets to the default client factory

func SetClientFactory

func SetClientFactory(factory ClientFactory)

SetClientFactory allows setting a custom client factory for testing

func ValidateWorkspace

func ValidateWorkspace(workspace string, credentials blaxel.Credentials) error

ValidateWorkspace validates workspace credentials

Types

type AuthErrorResponse

type AuthErrorResponse struct {
	Error            string `json:"error"`
	ErrorDescription string `json:"error_description"`
}

AuthErrorResponse represents an error response from auth

type ClientFactory

type ClientFactory func(opts ...option.RequestOption) WorkspaceLister

ClientFactory creates clients for workspace operations

type DeviceLogin

type DeviceLogin struct {
	ClientID string `json:"client_id"`
	Scope    string `json:"scope"`
}

DeviceLogin represents a device login request

type DeviceLoginFinalizeRequest

type DeviceLoginFinalizeRequest struct {
	GrantType  string `json:"grant_type"`
	ClientID   string `json:"client_id"`
	DeviceCode string `json:"device_code"`
}

DeviceLoginFinalizeRequest represents a device login finalize request

type DeviceLoginFinalizeResponse

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

DeviceLoginFinalizeResponse represents the response from device login finalize

type DeviceLoginResponse

type DeviceLoginResponse struct {
	DeviceCode              string `json:"device_code"`
	UserCode                string `json:"user_code"`
	VerificationURI         string `json:"verification_uri"`
	VerificationURIComplete string `json:"verification_uri_complete"`
	ExpiresIn               int    `json:"expires_in"`
	Interval                int    `json:"interval"`
}

DeviceLoginResponse represents the response from device login

type WorkspaceLister

type WorkspaceLister interface {
	List(ctx context.Context, opts ...option.RequestOption) (*[]blaxel.Workspace, error)
}

WorkspaceLister interface for listing workspaces (allows mocking)