user

Documentation

Index

• Variables
• type AuthModuleConversion
  • func (auth *AuthModuleConversion) FromDB(data []byte) error
  • func (auth *AuthModuleConversion) ToDB() ([]byte, error)
• type BatchDisableUsersCommand
• type ChangeUserPasswordCommand
• type CreateUserCommand
• type DeleteUserCommand
• type DisableUserCommand
• type ErrCaseInsensitiveLoginConflict
  • func (e *ErrCaseInsensitiveLoginConflict) Error() string
  • func (e *ErrCaseInsensitiveLoginConflict) Unwrap() error
• type Filter
• type FilterHandler
• type GetSignedInUserQuery
• type GetUserByEmailQuery
• type GetUserByIDQuery
• type GetUserByLoginQuery
• type GetUserProfileQuery
• type HelpFlags1
  • func (f *HelpFlags1) AddFlag(flag HelpFlags1)
  • func (f HelpFlags1) HasFlag(flag HelpFlags1) bool
• type InCondition
• type JoinCondition
• type SearchUserFilter
• type SearchUserQueryResult
• type SearchUsersQuery
• type Service
• type SetUserHelpFlagCommand
• type SetUsingOrgCommand
• type SignedInUser
  • func (u *SignedInUser) GetCacheKey() (string, error)
  • func (u *SignedInUser) HasRole(role roletype.RoleType) bool
  • func (u *SignedInUser) HasUniqueId() bool
  • func (u *SignedInUser) IsApiKeyUser() bool
  • func (u *SignedInUser) IsRealUser() bool
  • func (u *SignedInUser) NameOrFallback() string
  • func (u *SignedInUser) ShouldUpdateLastSeenAt() bool
  • func (u *SignedInUser) ToUserDisplayDTO() *UserDisplayDTO
• type UpdateUserCommand
• type UpdateUserLastSeenAtCommand
• type User
  • func (u *User) NameOrFallback() string
• type UserDisplayDTO
• type UserProfileDTO
• type UserSearchHitDTO
• type WhereCondition

Variables

var (
	ErrCaseInsensitive   = errors.New("case insensitive conflict")
	ErrUserNotFound      = errors.New("user not found")
	ErrUserAlreadyExists = errors.New("user already exists")
	ErrLastGrafanaAdmin  = errors.New("cannot remove last grafana admin")
	ErrProtectedUser     = errors.New("cannot adopt protected user")
	ErrNoUniqueID        = errors.New("identifying id not found")
)

Typed errors

Types

type AuthModuleConversion

type AuthModuleConversion []string

implement Conversion interface to define custom field mapping (xorm feature)

func (*AuthModuleConversion) FromDB

func (auth *AuthModuleConversion) FromDB(data []byte) error

func (*AuthModuleConversion) ToDB

func (auth *AuthModuleConversion) ToDB() ([]byte, error)

Just a stub, we don't want to write to database

type BatchDisableUsersCommand

type BatchDisableUsersCommand struct {
	UserIDs    []int64 `xorm:"user_ids"`
	IsDisabled bool
}

type ChangeUserPasswordCommand

type ChangeUserPasswordCommand struct {
	OldPassword string `json:"oldPassword"`
	NewPassword string `json:"newPassword"`

	UserID int64 `json:"-"`
}

type CreateUserCommand

type CreateUserCommand struct {
	Email            string
	Login            string
	Name             string
	Company          string
	OrgID            int64
	OrgName          string
	Password         string
	EmailVerified    bool
	IsAdmin          bool
	IsDisabled       bool
	SkipOrgSetup     bool
	DefaultOrgRole   string
	IsServiceAccount bool
}

type DeleteUserCommand

type DeleteUserCommand struct {
	UserID int64
}

type DisableUserCommand

type DisableUserCommand struct {
	UserID     int64 `xorm:"user_id"`
	IsDisabled bool
}

type ErrCaseInsensitiveLoginConflict

type ErrCaseInsensitiveLoginConflict struct {
	Users []User
}

func (*ErrCaseInsensitiveLoginConflict) Error

func (e *ErrCaseInsensitiveLoginConflict) Error() string

func (*ErrCaseInsensitiveLoginConflict) Unwrap

func (e *ErrCaseInsensitiveLoginConflict) Unwrap() error

type Filter

type Filter interface {
	WhereCondition() *WhereCondition
	InCondition() *InCondition
	JoinCondition() *JoinCondition
}

type FilterHandler

type FilterHandler func(params []string) (Filter, error)

type GetSignedInUserQuery

type GetSignedInUserQuery struct {
	UserID int64 `xorm:"user_id"`
	Login  string
	Email  string
	OrgID  int64 `xorm:"org_id"`
}

type GetUserByEmailQuery

type GetUserByEmailQuery struct {
	Email string
}

type GetUserByIDQuery

type GetUserByIDQuery struct {
	ID int64
}

type GetUserByLoginQuery

type GetUserByLoginQuery struct {
	LoginOrEmail string
}

type GetUserProfileQuery

type GetUserProfileQuery struct {
	UserID int64
}

type HelpFlags1

type HelpFlags1 uint64

const (
	HelpFlagGettingStartedPanelDismissed HelpFlags1 = 1 << iota
	HelpFlagDashboardHelp1
)

func (*HelpFlags1) AddFlag

func (f *HelpFlags1) AddFlag(flag HelpFlags1)

func (HelpFlags1) HasFlag

func (f HelpFlags1) HasFlag(flag HelpFlags1) bool

type InCondition

type InCondition struct {
	Condition string
	Params    interface{}
}

type JoinCondition

type JoinCondition struct {
	Operator string
	Table    string
	Params   string
}

type SearchUserFilter

type SearchUserFilter interface {
	GetFilter(filterName string, params []string) Filter
	GetFilterList() map[string]FilterHandler
}

type SearchUserQueryResult

type SearchUserQueryResult struct {
	TotalCount int64               `json:"totalCount"`
	Users      []*UserSearchHitDTO `json:"users"`
	Page       int                 `json:"page"`
	PerPage    int                 `json:"perPage"`
}

type SearchUsersQuery

type SearchUsersQuery struct {
	SignedInUser *SignedInUser
	OrgID        int64 `xorm:"org_id"`
	Query        string
	Page         int
	Limit        int
	AuthModule   string
	Filters      []Filter

	IsDisabled *bool
}

type Service

type Service interface {
	Create(context.Context, *CreateUserCommand) (*User, error)
	Delete(context.Context, *DeleteUserCommand) error
	GetByID(context.Context, *GetUserByIDQuery) (*User, error)
	GetByLogin(context.Context, *GetUserByLoginQuery) (*User, error)
	GetByEmail(context.Context, *GetUserByEmailQuery) (*User, error)
	Update(context.Context, *UpdateUserCommand) error
	ChangePassword(context.Context, *ChangeUserPasswordCommand) error
	UpdateLastSeenAt(context.Context, *UpdateUserLastSeenAtCommand) error
	SetUsingOrg(context.Context, *SetUsingOrgCommand) error
	GetSignedInUserWithCacheCtx(context.Context, *GetSignedInUserQuery) (*SignedInUser, error)
	GetSignedInUser(context.Context, *GetSignedInUserQuery) (*SignedInUser, error)
	Search(context.Context, *SearchUsersQuery) (*SearchUserQueryResult, error)
	Disable(context.Context, *DisableUserCommand) error
	BatchDisableUsers(context.Context, *BatchDisableUsersCommand) error
	UpdatePermissions(context.Context, int64, bool) error
	SetUserHelpFlag(context.Context, *SetUserHelpFlagCommand) error
	GetProfile(context.Context, *GetUserProfileQuery) (*UserProfileDTO, error)
}

type SetUserHelpFlagCommand

type SetUserHelpFlagCommand struct {
	HelpFlags1 HelpFlags1
	UserID     int64 `xorm:"user_id"`
}

type SetUsingOrgCommand

type SetUsingOrgCommand struct {
	UserID int64
	OrgID  int64
}

type SignedInUser

type SignedInUser struct {
	UserID             int64 `xorm:"user_id"`
	OrgID              int64 `xorm:"org_id"`
	OrgName            string
	OrgRole            roletype.RoleType
	ExternalAuthModule string
	ExternalAuthID     string
	Login              string
	Name               string
	Email              string
	ApiKeyID           int64 `xorm:"api_key_id"`
	OrgCount           int
	IsGrafanaAdmin     bool
	IsAnonymous        bool
	IsDisabled         bool
	HelpFlags1         HelpFlags1
	LastSeenAt         time.Time
	Teams              []int64
	// Permissions grouped by orgID and actions
	Permissions map[int64]map[string][]string `json:"-"`
}

func (*SignedInUser) GetCacheKey

func (u *SignedInUser) GetCacheKey() (string, error)

func (*SignedInUser) HasRole

func (u *SignedInUser) HasRole(role roletype.RoleType) bool

func (*SignedInUser) HasUniqueId

func (u *SignedInUser) HasUniqueId() bool

func (*SignedInUser) IsApiKeyUser

func (u *SignedInUser) IsApiKeyUser() bool

func (*SignedInUser) IsRealUser

func (u *SignedInUser) IsRealUser() bool

func (*SignedInUser) NameOrFallback

func (u *SignedInUser) NameOrFallback() string

func (*SignedInUser) ShouldUpdateLastSeenAt

func (u *SignedInUser) ShouldUpdateLastSeenAt() bool

func (*SignedInUser) ToUserDisplayDTO

func (u *SignedInUser) ToUserDisplayDTO() *UserDisplayDTO

type UpdateUserCommand

type UpdateUserCommand struct {
	Name  string `json:"name"`
	Email string `json:"email"`
	Login string `json:"login"`
	Theme string `json:"theme"`

	UserID int64 `json:"-"`
}

type UpdateUserLastSeenAtCommand

type UpdateUserLastSeenAtCommand struct {
	UserID int64
}

type User

type User struct {
	ID            int64 `xorm:"pk autoincr 'id'"`
	Version       int
	Email         string
	Name          string
	Login         string
	Password      string
	Salt          string
	Rands         string
	Company       string
	EmailVerified bool
	Theme         string
	HelpFlags1    HelpFlags1
	IsDisabled    bool

	IsAdmin          bool
	IsServiceAccount bool
	OrgID            int64 `xorm:"org_id"`

	Created    time.Time
	Updated    time.Time
	LastSeenAt time.Time
}

func (*User) NameOrFallback

func (u *User) NameOrFallback() string

type UserDisplayDTO

type UserDisplayDTO struct {
	ID        int64  `json:"id,omitempty"`
	Name      string `json:"name,omitempty"`
	Login     string `json:"login,omitempty"`
	AvatarUrl string `json:"avatarUrl"`
}

type UserProfileDTO

type UserProfileDTO struct {
	ID             int64           `json:"id"`
	Email          string          `json:"email"`
	Name           string          `json:"name"`
	Login          string          `json:"login"`
	Theme          string          `json:"theme"`
	OrgID          int64           `json:"orgId,omitempty"`
	IsGrafanaAdmin bool            `json:"isGrafanaAdmin"`
	IsDisabled     bool            `json:"isDisabled"`
	IsExternal     bool            `json:"isExternal"`
	AuthLabels     []string        `json:"authLabels"`
	UpdatedAt      time.Time       `json:"updatedAt"`
	CreatedAt      time.Time       `json:"createdAt"`
	AvatarUrl      string          `json:"avatarUrl"`
	AccessControl  map[string]bool `json:"accessControl,omitempty"`
}

type UserSearchHitDTO

type UserSearchHitDTO struct {
	ID            int64                `json:"id" xorm:"id"`
	Name          string               `json:"name"`
	Login         string               `json:"login"`
	Email         string               `json:"email"`
	AvatarURL     string               `json:"avatarUrl" xorm:"avatar_url"`
	IsAdmin       bool                 `json:"isAdmin"`
	IsDisabled    bool                 `json:"isDisabled"`
	LastSeenAt    time.Time            `json:"lastSeenAt"`
	LastSeenAtAge string               `json:"lastSeenAtAge"`
	AuthLabels    []string             `json:"authLabels"`
	AuthModule    AuthModuleConversion `json:"-"`
}

type WhereCondition

type WhereCondition struct {
	Condition string
	Params    interface{}
}