constants

Documentation

Index

• Constants
• Variables

Constants

const (
	ColApplications = "_Applications" // Contains information of the applications managed by the cluster
	ColDomains      = "_Domains"      // Contains domains information and configuration
)

Backd application specific

const (
	ColRBAC      = "_RBAC"      // ColRBAC is the collection that holds the Role Access for every object managed by the API
	ColRelations = "_Relations" // ColRelations is the collection that stores the relations of linked data
	ColFunctions = "_Functions" // ColFunctions is the collection that stores the functions code and its configuration
)

Application collections

const (
	ColUsers      = "_Users"      // Contains the users defined at domain level
	ColGroups     = "_Groups"     // Contains the groups defined at domain level
	ColMembership = "_Membership" // Relationship between users & groups
)

Domain collections to define security

const (
	DBBackdApp = "_backd" // this application cannot be browseable by API because of its name. It must not contain any collection or function created by users
	DBBackdDom = "backd"
)

Databases for Backd

const (
	GroupDomainAdministrators = "Domain Administrators"
	GroupAuthenticatedUsers   = "Authenticated Users"
)

Users and groups constants

const (
	ReasonReadingBody = "error getting data from body"
	ReasonBadQuery    = "bad query"
)

reasoning for HTTP errors

const (
	DefaultPerPage int64 = 20
)

Default values for common actions

const (
	SystemUserID = "backd000000000000000"
)

System User ID

Variables

var (
	// ErrBadConfiguration is returned when the configuration is not properly filled
	ErrBadConfiguration = errors.New("bad configuration")
)

var (
	// ErrItemWithoutID is returned when an item does not have an ID, that must have it
	ErrItemWithoutID = errors.New("item without id")
)

Data errors