apikey

Documentation

Index

• Variables
• func IsApiKeyNotFound(err error) bool
• type ApiKey
• type ApiKeyType
• type Store

Variables

var (
	ErrApiKeyNotFound = errors.New("api key not found")
)

Functions

func IsApiKeyNotFound

func IsApiKeyNotFound(err error) bool

Types

type ApiKey

type ApiKey struct {
	KeyHash string     `json:"keyHash" validate:"required"`
	Type    ApiKeyType `json:"type" validate:"required"`
	// Project or client name
	Name string `json:"name" validate:"required"`

} // @name ApiKey

type ApiKeyType

type ApiKeyType string

const (
	ApiKeyTypeClient    ApiKeyType = "client"
	ApiKeyTypeProject   ApiKeyType = "project"
	ApiKeyTypeWorkspace ApiKeyType = "workspace"
)

type Store

type Store interface {
	List() ([]*ApiKey, error)
	Find(key string) (*ApiKey, error)
	FindByName(name string) (*ApiKey, error)
	Save(apiKey *ApiKey) error
	Delete(apiKey *ApiKey) error
}