users

Documentation

Overview

Package users provides a series of HTTP handlers for managing users, passwords, and two factor secrets in a compatible database.

Index

• Constants
• Variables
• func ProvideUsersService(authSettings *authservice.Config, logger logging.Logger, ...) types.UserDataService
• type RequestValidator

Constants

const (
	// UserIDURIParamKey is used to refer to user IDs in router params.
	UserIDURIParamKey = "userID"
)

Variables

var Providers = wire.NewSet(
	ProvideUsersService,
)

Providers is what we provide for dependency injectors.

Functions

func ProvideUsersService

func ProvideUsersService(
	authSettings *authservice.Config,
	logger logging.Logger,
	userDataManager types.UserDataManager,
	accountDataManager types.AccountDataManager,
	authenticator authentication.Authenticator,
	encoder encoding.ServerEncoderDecoder,
	counterProvider metrics.UnitCounterProvider,
	imageUploadProcessor images.ImageUploadProcessor,
	uploadManager uploads.UploadManager,
	routeParamManager routing.RouteParamManager,
) types.UserDataService

ProvideUsersService builds a new UsersService.

Types

type RequestValidator

type RequestValidator interface {
	Validate(req *http.Request) (bool, error)
}

RequestValidator validates request.