workflows

Documentation

Index

• Constants
• type Action
• type Actor
  • func (a Actor) Validate() error
• type ActorType
• type AuditLog
  • func (l AuditLog) Validate() error
• type AuditWorkflow
• type Client
  • func NewClient(url string, opts ...ClientOptions) Client
• type ClientOptions
• type Object
  • func (o Object) Validate() error
• type ObjectType

Constants

const (
	HealthCheckURI = "/api/v1/health"
	ResetEmailURI  = "/api/v1/workflow/send_password_reset_email"
	AuditlogsURI   = "/api/v1/workflow/emit_auditlog"
)

Types

type Action

type Action string

const (
	ActionTerminalOpen     Action = "open_terminal"
	ActionTerminalClose    Action = "close_terminal"
	ActionPortForwardOpen  Action = "open_portforward"
	ActionPortForwardClose Action = "close_portforward"
	ActionDownloadFile     Action = "download_file"
	ActionUploadFile       Action = "upload_file"
)

type Actor

type Actor struct {
	ID             string    `json:"id"`
	Type           ActorType `json:"type"`
	Email          string    `json:"email,omitempty"`
	DeviceIdentity string    `json:"identity_data,omitempty"`
}

func (Actor) Validate

func (a Actor) Validate() error

type ActorType

type ActorType string

const (
	ActorUser ActorType = "user"
)

type AuditLog

type AuditLog struct {
	Action   Action              `json:"action"`
	Actor    Actor               `json:"actor"`
	Object   Object              `json:"object"`
	Change   string              `json:"change,omitempty"`
	MetaData map[string][]string `json:"meta,omitempty"`
	EventTS  time.Time           `json:"time,omitempty"`
}

func (AuditLog) Validate

func (l AuditLog) Validate() error

type AuditWorkflow

type AuditWorkflow struct {
	RequestID string   `json:"request_id"`
	TenantID  string   `json:"tenant_id"`
	AuditLog  AuditLog `json:"auditlog"`
}

type Client

type Client interface {
	CheckHealth(ctx context.Context) error
	SubmitAuditLog(ctx context.Context, log AuditLog) error
}

Client is the workflows client

func NewClient

func NewClient(url string, opts ...ClientOptions) Client

NewClient returns a new workflows client

type ClientOptions

type ClientOptions struct {
	Client *http.Client
}

type Object

type Object struct {
	ID   string     `json:"id"`
	Type ObjectType `json:"type"`
}

func (Object) Validate

func (o Object) Validate() error

type ObjectType

type ObjectType string

const ObjectDevice ObjectType = "device"