cli/packages/models/cli.go

package models

import "time"

type UserCredentials struct {
	Email        string `json:"email"`
	PrivateKey   string `json:"privateKey"`
	JTWToken     string `json:"JTWToken"`
	RefreshToken string `json:"RefreshToken"`
}

// The file struct for KMS config file
type ConfigFile struct {
	LoggedInUserEmail      string         `json:"loggedInUserEmail"`
	LoggedInUserDomain     string         `json:"LoggedInUserDomain,omitempty"`
	LoggedInUsers          []LoggedInUser `json:"loggedInUsers,omitempty"`
	VaultBackendType       string         `json:"vaultBackendType,omitempty"`
	VaultBackendPassphrase string         `json:"vaultBackendPassphrase,omitempty"`
	Domains                []string       `json:"domains,omitempty"`
}

type LoggedInUser struct {
	Email  string `json:"email"`
	Domain string `json:"domain"`
}

type Tag struct {
	ID    string `json:"_id"`
	Name  string `json:"name"`
	Slug  string `json:"slug"`
	Color string `json:"color"`
}

type SingleEnvironmentVariable struct {
	Key                   string `json:"key"`
	WorkspaceId           string `json:"workspace"`
	Value                 string `json:"value"`
	Type                  string `json:"type"`
	ID                    string `json:"_id"`
	SecretPath            string `json:"secretPath"`
	Tags                  []Tag  `json:"tags"`
	Comment               string `json:"comment"`
	Etag                  string `json:"Etag"`
	SkipMultilineEncoding bool   `json:"skipMultilineEncoding"`
}

// TLDR; Why you shouldn't depend on "SkipMultilineEncoding" and instead use this method
// "SkipMultilineEncoding" generally means that the value should not be encoded as a multiline string
// But due to historic reasons this property actually does the opposite - it encodes the value as a multiline string
func (s SingleEnvironmentVariable) IsMultilineEncodingEnabled() bool {
	// Encode the value only if "skipMultilineEncoding" doesn't exist or is true
	return s.SkipMultilineEncoding
}

type PlaintextSecretResult struct {
	Secrets []SingleEnvironmentVariable
	Etag    string
}

type DynamicSecret struct {
	Id         string `json:"id"`
	DefaultTTL string `json:"defaultTTL"`
	MaxTTL     string `json:"maxTTL"`
	Type       string `json:"type"`
}

type DynamicSecretLeaseWithoutData struct {
	Lease struct {
		Id       string    `json:"id"`
		ExpireAt time.Time `json:"expireAt"`
	} `json:"lease"`
	DynamicSecret DynamicSecret `json:"dynamicSecret"`
}

type DynamicSecretLease struct {
	Lease struct {
		Id       string    `json:"id"`
		ExpireAt time.Time `json:"expireAt"`
	} `json:"lease"`
	DynamicSecret DynamicSecret `json:"dynamicSecret"`
	// this is a varying dict based on provider
	Data map[string]interface{} `json:"data"`
}

type TokenDetails struct {
	Type   string
	Token  string
	Source string
}

type SingleFolder struct {
	ID   string `json:"_id"`
	Name string `json:"name"`
}

type Workspace struct {
	ID             string `json:"_id"`
	Name           string `json:"name"`
	Plan           string `json:"plan,omitempty"`
	V              int    `json:"__v"`
	OrganizationId string `json:"orgId"`
}

type WorkspaceConfigFile struct {
	WorkspaceId                   string            `json:"workspaceId"`
	DefaultEnvironment            string            `json:"defaultEnvironment"`
	GitBranchToEnvironmentMapping map[string]string `json:"gitBranchToEnvironmentMapping"`
}

type SymmetricEncryptionResult struct {
	CipherText []byte `json:"CipherText"`
	Nonce      []byte `json:"Nonce"`
	AuthTag    []byte `json:"AuthTag"`
}

type GetAllSecretsParameters struct {
	Environment              string
	EnvironmentPassedViaFlag bool
	KMSToken           string
	UniversalAuthAccessToken string
	TagSlugs                 string
	WorkspaceId              string
	SecretsPath              string
	IncludeImport            bool
	Recursive                bool
	ExpandSecretReferences   bool
}

type InjectableEnvironmentResult struct {
	Variables    []string
	ETag         string
	SecretsCount int
}

type GetAllFoldersParameters struct {
	WorkspaceId              string
	Environment              string
	FoldersPath              string
	KMSToken           string
	UniversalAuthAccessToken string
}

type CreateFolderParameters struct {
	FolderName     string
	WorkspaceId    string
	Environment    string
	FolderPath     string
	KMSToken string
}

type DeleteFolderParameters struct {
	FolderName     string
	WorkspaceId    string
	Environment    string
	FolderPath     string
	KMSToken string
}

type ExpandSecretsAuthentication struct {
	KMSToken           string
	UniversalAuthAccessToken string
}

type MachineIdentityCredentials struct {
	ClientId     string
	ClientSecret string
}

type SecretSetOperation struct {
	SecretKey       string
	SecretValue     string
	SecretOperation string
}

type BackupSecretKeyRing struct {
	ProjectID   string `json:"projectId"`
	Environment string `json:"environment"`
	SecretPath  string `json:"secretPath"`
	Secrets     []SingleEnvironmentVariable
}