account

Documentation

Index

• type Account
  • func NewAccount(db Database, collection string, response Response, providers ...Provider) *Account
  • func (a *Account) CreateUserProfile(username, string, group string, provider string, ...) (*Profile, error)
  • func (a *Account) DeleteUserProfile(userID primitive.ObjectID) error
  • func (a *Account) Router(r chi.Router)
• type Database
• type Profile
• type Provider
• type Response

Types

type Account

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

func NewAccount

func NewAccount(db Database, collection string, response Response, providers ...Provider) *Account

func (*Account) CreateUserProfile

func (a *Account) CreateUserProfile(username, string, group string, provider string, providerData map[string]string) (*Profile, error)

Метод служит для создания пользовательского профиля в системе

func (*Account) DeleteUserProfile

func (a *Account) DeleteUserProfile(userID primitive.ObjectID) error

Метод служит для псевдо-удаления пользовательского профиля

!Важно так как пока пользовательский профиль существовал возможно, что были созданы его ссылки с другими документами, о которых данная структура знать не может, удаление пользовательского профиля лишь затирает чуствительные поля и запрещает пользователю производить какие-либо дополнительные действия

Так же будут удалены связи необходимые для авторизации пользователя с данным профилем в хранящиеся в документе

!ВАЖНО access_token следует удалить у пользователя самостоятельно, так как он будет действовать корректно в пределах своего срока жизни

func (*Account) Router

func (a *Account) Router(r chi.Router)

Метод производит подключение провайдеров авторизации к роутеру проекта

Из реализуемых внутри структуры Account роутов присутствуют /refresh - для обновления пользовательского токена /logout - для выхода пользователя из системы

далее по схеме создаются группы методов для каждого конкретного провайдера по схеме /{provider_name}/<методы реализованные у провайдера>

type Database

type Database interface {
	Operation(func(ctx context.Context, db *mongo.Database) error) error
}

type Profile

type Profile struct {
	ID       primitive.ObjectID `bson:"_id"`
	Group    string             `bson:"group"`
	Username string             `bson:"username"`
}

type Provider

type Provider interface {
	GetName() string
	GetRouter(r chi.Router)
}

type Response

type Response interface {
	secure.Response
}