users

Documentation

Index

• Variables
• type Authenticator
• type Store
• type User

Variables

var ErrAuthenticationFailure = errors.New("authentication failure")

ErrAuthenticationFailure indicates that the user cannot be identified with the provided information.

Types

type Authenticator

type Authenticator interface {
	Authenticate(ctx context.Context, userID string, params ...string) (*User, error)
}

Authenticator allows to check whether a user is allowed in the system or not.

type Store

type Store interface {
	Authenticator
	CreateUser(ctx context.Context, name, email, password string) (*User, error)
	DeleteUser(ctx context.Context, user *User) error
}

type User

type User struct {
	Email string
	Name  string
}

User represent a users and its fields in the system.