user

Documentation

Index

• Variables
• func ChangePassword(userID string, current string, newPassword string) error
• func Disable(userID string) error
• func Enable(userID string) error
• func Grant(userID string, permissions []string) error
• func Granted(userID string, permission string) bool
• func Revoke(userID string, permissions []string) error
• func SignIn(login string, password string) (string, error)
• func SignUp(user *SignUpRequest) (string, error)
• type SignUpRequest
• type User
  • func Get(userID string) (*User, error)
  • func NewUser() *User
  • func Users() ([]*User, error)
  • func (e *User) Grant(permission string)
  • func (e *User) Granted(permission string) bool
  • func (e *User) Revoke(permission string)
  • func (e *User) SetPasswordText(pwd string) error
  • func (e *User) ValidatePassword(plainPwd string) error
  • func (e *User) ValidateSchema() error

Variables

var ErrLogin = errors.NewValidationField("login", "invalid")

ErrLogin el login es invalido

var ErrLoginExist = errors.NewValidationField("login", "exist")

ErrLoginExist el login ya existe

var ErrPassword = errors.NewValidationField("password", "invalid")

ErrPassword el password es invalido

Functions

func ChangePassword

func ChangePassword(userID string, current string, newPassword string) error

ChangePassword cambiar la contraseña del usuario indicado

func Disable

func Disable(userID string) error

Disable deshabilita un usuario

func Enable

func Enable(userID string) error

Enable habilita un usuario

func Grant

func Grant(userID string, permissions []string) error

Grant Le habilita los permisos enviados por parametros

func Granted

func Granted(userID string, permission string) bool

Granted verifica si el usuario tiene el permiso

func Revoke

func Revoke(userID string, permissions []string) error

Revoke Le revoca los permisos enviados por parametros

func SignIn

func SignIn(login string, password string) (string, error)

SignIn is the controller to sign in users

func SignUp

func SignUp(user *SignUpRequest) (string, error)

SignUp is the controller to signup new users

Types

type SignUpRequest

type SignUpRequest struct {
	Name     string `json:"name" binding:"required"`
	Password string `json:"password" binding:"required"`
	Login    string `json:"login" binding:"required"`
}

SignUpRequest es un nuevo usuario

type User

type User struct {
	ID          primitive.ObjectID `bson:"_id"`
	Name        string             `bson:"name" validate:"required,min=1,max=100"`
	Login       string             `bson:"login" validate:"required,min=5,max=100"`
	Password    string             `bson:"password" validate:"required"`
	Permissions []string           `bson:"permissions"`
	Enabled     bool               `bson:"enabled"`
	Created     time.Time          `bson:"created"`
	Updated     time.Time          `bson:"updated"`
}

User data structure

func Get

func Get(userID string) (*User, error)

Get wrapper para obtener un usuario

func NewUser

func NewUser() *User

NewUser Nueva instancia de usuario

func Users

func Users() ([]*User, error)

Users wrapper para obtener todos los usuarios

func (*User) Grant

func (e *User) Grant(permission string)

Grant le otorga el permiso indicado al usuario

func (*User) Granted

func (e *User) Granted(permission string) bool

Granted verifica si el usuario tiene el permiso indicado

func (*User) Revoke

func (e *User) Revoke(permission string)

Revoke le revoca el permiso indicado al usuario

func (*User) SetPasswordText

func (e *User) SetPasswordText(pwd string) error

SetPasswordText Asigna la contraseña en modo texto, la encripta

func (*User) ValidatePassword

func (e *User) ValidatePassword(plainPwd string) error

ValidatePassword Valida si la contraseña es la correcta

func (*User) ValidateSchema

func (e *User) ValidateSchema() error

ValidateSchema valida la estructura para ser insertada en la db