events

Documentation

Index

• Constants
• type OrgBase
  • func (p *OrgBase) ActionInfo() (json.RawMessage, error)
  • func (p *OrgBase) RequiresActor() bool
  • func (p *OrgBase) TargetID() *uuid.UUID
  • func (p *OrgBase) TargetType() auditor.TargetType
• type OrgCreated
  • func (p *OrgCreated) ActionType() string
  • func (p *OrgCreated) Description() string
• type OrgUserInvited
  • func (p *OrgUserInvited) ActionInfo() (json.RawMessage, error)
  • func (p *OrgUserInvited) ActionType() string
  • func (p *OrgUserInvited) Description() string
• type OrgUserJoined
  • func (p *OrgUserJoined) ActionType() string
  • func (p *OrgUserJoined) Description() string
• type OrgUserLeft
  • func (p *OrgUserLeft) ActionType() string
  • func (p *OrgUserLeft) Description() string
• type UserBase
  • func (p *UserBase) ActionInfo() (json.RawMessage, error)
  • func (p *UserBase) RequiresActor() bool
  • func (p *UserBase) TargetID() *uuid.UUID
  • func (p *UserBase) TargetType() auditor.TargetType
• type UserLoggedIn
  • func (p *UserLoggedIn) ActionInfo() (json.RawMessage, error)
  • func (p *UserLoggedIn) ActionType() string
  • func (p *UserLoggedIn) Description() string
• type UserSignedUp
  • func (p *UserSignedUp) ActionType() string
  • func (p *UserSignedUp) Description() string

Constants

const (
	UserType               auditor.TargetType = "User"
	UserSignedUpActionType string             = "SignedUp"
	UserLoggedInActionType string             = "LoggedIn"
)

const (
	OrgType auditor.TargetType = "Organization"
)

Types

type OrgBase

type OrgBase struct {
	OrgID   *uuid.UUID `json:"org_id,omitempty"`
	OrgName string     `json:"org_name,omitempty"`
}

func (*OrgBase) ActionInfo

func (p *OrgBase) ActionInfo() (json.RawMessage, error)

func (*OrgBase) RequiresActor

func (p *OrgBase) RequiresActor() bool

func (*OrgBase) TargetID

func (p *OrgBase) TargetID() *uuid.UUID

func (*OrgBase) TargetType

func (p *OrgBase) TargetType() auditor.TargetType

type OrgCreated

type OrgCreated struct {
	*OrgBase
}

Org created

func (*OrgCreated) ActionType

func (p *OrgCreated) ActionType() string

func (*OrgCreated) Description

func (p *OrgCreated) Description() string

type OrgUserInvited

type OrgUserInvited struct {
	*OrgBase
	ReceiverEmail string
	Role          string
}

user got invited to the organization

func (*OrgUserInvited) ActionInfo

func (p *OrgUserInvited) ActionInfo() (json.RawMessage, error)

func (*OrgUserInvited) ActionType

func (p *OrgUserInvited) ActionType() string

func (*OrgUserInvited) Description

func (p *OrgUserInvited) Description() string

type OrgUserJoined

type OrgUserJoined struct {
	*OrgBase
}

user joined the organization

func (*OrgUserJoined) ActionType

func (p *OrgUserJoined) ActionType() string

func (*OrgUserJoined) Description

func (p *OrgUserJoined) Description() string

type OrgUserLeft

type OrgUserLeft struct {
	*OrgBase
}

user left the organization

func (*OrgUserLeft) ActionType

func (p *OrgUserLeft) ActionType() string

func (*OrgUserLeft) Description

func (p *OrgUserLeft) Description() string

type UserBase

type UserBase struct {
	UserID *uuid.UUID `json:"user_id,omitempty"`
	Email  string     `json:"email,omitempty"`
}

UserBase is the base struct for policy events

func (*UserBase) ActionInfo

func (p *UserBase) ActionInfo() (json.RawMessage, error)

func (*UserBase) RequiresActor

func (p *UserBase) RequiresActor() bool

func (*UserBase) TargetID

func (p *UserBase) TargetID() *uuid.UUID

func (*UserBase) TargetType

func (p *UserBase) TargetType() auditor.TargetType

type UserLoggedIn

type UserLoggedIn struct {
	*UserBase
	// This timestamp can be used to generate a new digest for the user and burst the cache
	LoggedIn time.Time
}

func (*UserLoggedIn) ActionInfo

func (p *UserLoggedIn) ActionInfo() (json.RawMessage, error)

func (*UserLoggedIn) ActionType

func (p *UserLoggedIn) ActionType() string

func (*UserLoggedIn) Description

func (p *UserLoggedIn) Description() string

type UserSignedUp

type UserSignedUp struct {
	*UserBase
}

func (*UserSignedUp) ActionType

func (p *UserSignedUp) ActionType() string

func (*UserSignedUp) Description

func (p *UserSignedUp) Description() string