users

Documentation

Index

• func Routes(app *web.App, cfg Config)
• type AppNewUser
  • func (app AppNewUser) Validate() error
• type AppUpdateUser
  • func (app AppUpdateUser) Validate() error
• type AppUser
• type Config
• type Handlers
  • func New(uc *user.Core, auth *auth.Auth) *Handlers
  • func (h *Handlers) Create(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (h *Handlers) Query(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (h *Handlers) Token(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Functions

func Routes

func Routes(app *web.App, cfg Config)

Routes adds specific routes for this group.

Types

type AppNewUser

type AppNewUser struct {
	Name            string   `json:"name" validate:"required"`
	Email           string   `json:"email" validate:"required,email"`
	Roles           []string `json:"roles" validate:"required"`
	Department      string   `json:"department"`
	Password        string   `json:"password" validate:"required"`
	PasswordConfirm string   `json:"passwordConfirm" validate:"eqfield=Password"`
}

AppNewUser contains information needed to create a new user.

func (AppNewUser) Validate

func (app AppNewUser) Validate() error

Validate checks the data in the model is considered clean.

type AppUpdateUser

type AppUpdateUser struct {
	Name            *string  `json:"name"`
	Email           *string  `json:"email" validate:"omitempty,email"`
	Roles           []string `json:"roles"`
	Department      *string  `json:"department"`
	Password        *string  `json:"password"`
	PasswordConfirm *string  `json:"passwordConfirm" validate:"omitempty,eqfield=Password"`
	Enabled         *bool    `json:"enabled"`
}

AppUpdateUser contains information needed to update a user.

func (AppUpdateUser) Validate

func (app AppUpdateUser) Validate() error

Validate checks the data in the model is considered clean.

type AppUser

type AppUser struct {
	ID           string   `json:"id"`
	Name         string   `json:"name"`
	Email        string   `json:"email"`
	Roles        []string `json:"roles"`
	PasswordHash []byte   `json:"-"`
	Department   string   `json:"department"`
	Enabled      bool     `json:"enabled"`
	DateCreated  string   `json:"dateCreated"`
	DateUpdated  string   `json:"dateUpdated"`
}

AppUser represents information about an individual user.

type Config

type Config struct {
	Log  *logger.Logger
	Auth *auth.Auth
	DB   *sqlx.DB
}

Config contains all the mandatory systems required by handlers.

type Handlers

type Handlers struct {
	// contains filtered or unexported fields
}

Handlers manages the set of user endpoints.

func New

func New(uc *user.Core, auth *auth.Auth) *Handlers

New constructs a new handlers struct for route access.

func (*Handlers) Create

func (h *Handlers) Create(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Create adds a new user to the system.

func (*Handlers) Query

func (h *Handlers) Query(ctx context.Context, w http.ResponseWriter, r *http.Request) error

func (*Handlers) Token

func (h *Handlers) Token(ctx context.Context, w http.ResponseWriter, r *http.Request) error