user

Documentation

Overview

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Code generated by go generate forge validation v0.2.0. DO NOT EDIT.

Index

• type Hook
• type HookProps
• type ResUserGet
• type ResUserGetPublic
• type Service
  • func New(users usermodel.Repo, roles rolemodel.Repo, sessions sessionmodel.Repo, ...) Service
• type User

Types

type Hook

type Hook interface {
	UserCreateHook(props HookProps) error
	UserDeleteHook(userid string) error
}

Hook is a service that can hook onto the user create and destroy pipelines

type HookProps

type HookProps struct {
	Userid    string
	Username  string
	Email     string
	FirstName string
	LastName  string
}

HookProps are properties of the user passed on to each hook

type ResUserGet

type ResUserGet struct {
	ResUserGetPublic
	Email string `json:"email"`
}

ResUserGet holds all the fields of a user

type ResUserGetPublic

type ResUserGetPublic struct {
	Userid       string `json:"userid"`
	Username     string `json:"username"`
	AuthTags     string `json:"auth_tags"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
	CreationTime int64  `json:"creation_time"`
}

ResUserGetPublic holds the public fields of a user

type Service

type Service interface {
	governor.Service
	User
}

func New

func New(users usermodel.Repo, roles rolemodel.Repo, sessions sessionmodel.Repo, kv kvstore.KVStore, mailer mail.Mail, g gate.Gate) Service

New creates a new User

type User

type User interface {
	GetByID(userid string) (*ResUserGet, error)
	RegisterHook(hook Hook)
}

User is a user management service