api

Documentation

Index

• type Authenticator
• type Decision
• type Identity

Types

type Authenticator

type Authenticator interface {

	// TODO: update the return value so it can carry a message in the DENY case
	Authenticate(context.Context, transport.Transporter) (*Identity, Decision)
}

type Decision

type Decision string

const (
	Allow  Decision = "ALLOW"
	Deny   Decision = "DENY"
	Ignore Decision = "IGNORE"
)

type Identity

type Identity struct {

	// TODO: do we even need the tenant id?
	Tenant string `yaml:"tenant"`

	Principal string   `yaml:"principal"`
	Groups    []string `yaml:"groups"`

	// TODO: If we explicitly represent reporters in the database, do we need to distinguish them when they authenticate?
	IsReporter bool   `yaml:"is_reporter"`
	Type       string `yaml:"type"`
	Href       string `yaml:"href"`
	IsGuest    bool   `yaml:"is_guest"`
}

Identity is the identity of the requester