users

package module

Go to main page

Versions in this module

v0

v0.2.0

Dec 18, 2020

v0.1.7

Dec 27, 2020

Changes in this version

type API

+ func (a *API) GetWorkspaceRole(r *http.Request, workspaceID string) (string, error)

+ func (a *API) InviteGuests(r *http.Request, workspaceID string, guests []string) error

type User

+ Workspaces []Workspace

+ type Workspace struct

+ ID string

+ Name string

+ Role string

+ type WorkspaceStore interface

+ CreateGroup func(userID, workspaceID, name, description string, metadata map[string]interface{}) (string, error)

+ CreatePermission func(roleID, action, target string) error

+ CreateUserRole func(userID, role string) error

+ CreateWorkspace func(userID, name, description, plan string, metadata map[string]interface{}) (string, error)

+ DeleteGroup func(groupID string) error

+ DeletePermission func(roleID, action string) error

+ DeleteUserRole func(userID, role string) error

+ DeleteWorkspace func(workspaceID string) error

+ GetGroup func(id string) (string, string, map[string]interface{}, error)

+ GetUserGroupRoles func(userID string) (map[string]string, error)

+ GetUserPermissions func(userID string) (map[string]string, error)

+ GetUserRoles func(userID string) ([]string, error)

+ GetUserWorkspaces func(userID string) (map[string][]string, error)

+ GetWorkspace func(id string) (string, string, map[string]interface{}, error)

+ GetWorkspaceGroups func(workspaceID string) ([]string, error)

+ GroupRemoveUser func(groupID, userID string) error

+ GroupUpsertUser func(groupID, userID, role string) error

+ UpdateGroup func(groupID, name, description string, metadata map[string]interface{}) error

+ UpdatePermission func(roleID, action, target string) error

+ UpdateWorkspace func(workspaceID, name, description, plan string, metadata map[string]interface{}) error

+ WorkspaceRemoveUser func(workspaceID, userID string) error

+ WorkspaceUpsertUser func(workspaceID, userID, role string) error

+ func NewDefaultWorkspaceStore(ctx context.Context, driver, dataSource string) (WorkspaceStore, error)

v0.1.6

Dec 22, 2020

Changes in this version

+ const CtxUserIdKey

type Permission

+ func NewPermission(action string, targetMatcher func(userID string) rbac.Matcher) Permission

v0.1.5

Dec 21, 2020

Changes in this version

type API

+ func (a *API) AddRole(r *http.Request, role string) error

+ func (a *API) Can(r *http.Request, action, target string) (bool, error)

+ func (a *API) ClearRoles(r *http.Request) error

+ func (a *API) DeleteRole(r *http.Request, role string) error

+ func (a *API) GetRoles(r *http.Request) ([]string, error)

type Config

+ Roles map[string][]Permission

+ type Permission struct

+ ActionMatcher func(action string) (bool, error)

+ TargetMatcher func(userID string) func(target string) (bool, error)

type UserStore

+ AddRole func(id, role string) error

+ ClearRoles func(id string) error

+ DeleteRole func(id, role string) error

+ GetRoles func(id string) ([]string, error)

v0.1.4

Dec 19, 2020

v0.1.3

Dec 19, 2020

Changes in this version

type API

+ func (a *API) GetSessionStringVal(r *http.Request, key string) *string

v0.1.2

Dec 18, 2020

Changes in this version

type API

+ func (a *API) UpdateBillingID(r *http.Request, billingID string) error

type User

+ BillingID string

type UserStore

+ UpdateBillingID func(id, billingID string) error

v0.1.1

Dec 14, 2020

v0.1.0

Dec 14, 2020

Changes in this version

+ const ChangeEmail

+ const Confirmation

+ const OTP

+ const Recovery

+ var ErrEmailNotConfirmed = errors.New("email has not been confirmed")

+ var ErrInternal = errors.New("internal server error")

+ var ErrInvalidEmail = errors.New("email is invalid")

+ var ErrInvalidPassword = errors.New("password is invalid")

+ var ErrLoginSessionNotFound = errors.New("a valid login session wasn't found")

+ var ErrSendingEmail = errors.New("problem sending the email")

+ var ErrSessionValNotFound = errors.New("session val not found")

+ var ErrUserExists = errors.New("email is already linked to a user")

+ var ErrUserNotFound = errors.New("user not found")

+ var ErrUserNotLoggedIn = errors.New("user is not logged in")

+ var ErrWrongPassword = errors.New("password is wrong")

+ type API struct

+ func NewAPI(ctx context.Context, apiMasterSecret string, userStore UserStore, ...) *API

+ func NewDefaultAPI(ctx context.Context, cfg Config) (*API, error)

+ func (a *API) ChangeEmail(id, newEmail string) error

+ func (a *API) ConfirmEmail(token string) error

+ func (a *API) ConfirmEmailChange(token string) error

+ func (a *API) ConfirmRecovery(token, password string) error

+ func (a *API) DelSessionVal(r *http.Request, w http.ResponseWriter, key string) error

+ func (a *API) DeleteMetaDataKeys(id string, keys []string) error

+ func (a *API) DeleteUser(r *http.Request) error

+ func (a *API) GetSessionVal(r *http.Request, key string) (interface{}, error)

+ func (a *API) HandleGothCallback(w http.ResponseWriter, r *http.Request) error

+ func (a *API) HandleGothLogin(w http.ResponseWriter, r *http.Request) error

+ func (a *API) HandleGothLogout(w http.ResponseWriter, r *http.Request) error

+ func (a *API) IsAuthenticated(next http.Handler) http.Handler

+ func (a *API) LoggedInUser(r *http.Request) (*User, error)

+ func (a *API) Login(w http.ResponseWriter, r *http.Request, email, password string) error

+ func (a *API) LoginWithOTP(w http.ResponseWriter, r *http.Request, otp string) error

+ func (a *API) Logout(w http.ResponseWriter, r *http.Request)

+ func (a *API) OTP(email string) error

+ func (a *API) Recovery(email string) error

+ func (a *API) ResetAPIToken(r *http.Request) (string, error)

+ func (a *API) SetSessionVal(r *http.Request, w http.ResponseWriter, key string, val interface{}) error

+ func (a *API) Signup(email, password string, metadata map[string]interface{}) error

+ func (a *API) UpdateMetaData(id string, metaData map[string]interface{}) error

+ type Config struct

+ APIMasterSecret string

+ Datasource string

+ Driver string

+ GothProviders []goth.Provider

+ SendMail SendMailFunc

+ SessionSecret string

+ type MailType int

+ type SendMailFunc func(mailType MailType, token, sendTo string, metadata map[string]interface{}) error

+ type SessionsStore interface

+ Close func() error

+ func NewDefaultSessionStore(ctx context.Context, driver, dataSource string, keyPairs ...[]byte) (SessionsStore, error)

+ type User struct

+ Email string

+ ID string

+ IsAPITokenSet bool

+ Metadata map[string]interface{}

+ type UserStore interface

+ Close func() error

+ DeleteAllMetadata func(id string) error

+ DeleteConfirmToken func(id string) error

+ DeleteEmailChangeToken func(id string) error

+ DeleteKeysMetaData func(id string, keys []string) error

+ DeleteOTP func(id string) error

+ DeleteRecoveryToken func(id string) error

+ DeleteUser func(id string) error

+ GetAPIKey func(id string) (string, error)

+ GetEmailChange func(id string) (string, error)

+ GetPassword func(id string) (string, error)

+ IsEmailConfirmed func(id string) (bool, error)

+ MarkConfirmed func(id string, confirmed bool) error

+ New func(email, password, provider string, meta map[string]interface{}) (string, error)

+ SaveConfirmationToken func(id, token string) error

+ SaveConfirmationTokenSentAt func(id string, tokenSentAt time.Time) error

+ SaveEmailChangeToken func(id, email, token string) error

+ SaveEmailChangeTokenSentAt func(id string, tokenSentAt time.Time) error

+ SaveOTP func(id, otp string) error

+ SaveOTPSentAt func(id string, otpSentAt time.Time) error

+ SaveRecoveryToken func(id, token string) error

+ SaveRecoveryTokenSentAt func(id string, tokenSentAt time.Time) error

+ SetLastSignInAt func(id string, time time.Time) error

+ SetUpdatedAt func(id string, time time.Time) error

+ UpdateAPIKey func(id, apiKey string) error

+ UpdateEmail func(id, email string) error

+ UpdatePassword func(id, password string) error

+ UpdateProvider func(id, provider string) error

+ UpsertMetaData func(id string, metaData map[string]interface{}) error

+ UserData func(id string) (string, string, map[string]interface{}, error)

+ UserIDByAPIKey func(apiKey string) (string, error)

+ UserIDByConfirmationToken func(token string) (string, error)

+ UserIDByEmail func(email string) (string, error)

+ UserIDByEmailChangeToken func(token string) (string, error)

+ UserIDByOTP func(token string) (string, error)

+ UserIDByRecoveryToken func(token string) (string, error)

+ func NewDefaultUserStore(ctx context.Context, driver, dataSource string) (UserStore, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL