user

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(user *portainer.User) error
  • func (service *Service) DeleteUser(ID portainer.UserID) error
  • func (service *Service) UpdateUser(ID portainer.UserID, user *portainer.User) error
  • func (service *Service) User(ID portainer.UserID) (*portainer.User, error)
  • func (service *Service) UserByUsername(username string) (*portainer.User, error)
  • func (service *Service) Users() ([]portainer.User, error)
  • func (service *Service) UsersByRole(role portainer.UserRole) ([]portainer.User, error)

Constants

const (
	// BucketName represents the name of the bucket where this service stores data.
	BucketName = "users"
)

Types

type Service

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

Service represents a service for managing environment(endpoint) data.

func NewService

func NewService(connection portainer.Connection) (*Service, error)

NewService creates a new instance of a service.

func (*Service) BucketName

func (service *Service) BucketName() string

func (*Service) Create

func (service *Service) Create(user *portainer.User) error

CreateUser creates a new user.

func (*Service) DeleteUser

func (service *Service) DeleteUser(ID portainer.UserID) error

DeleteUser deletes a user.

func (*Service) UpdateUser

func (service *Service) UpdateUser(ID portainer.UserID, user *portainer.User) error

UpdateUser saves a user.

func (*Service) User

func (service *Service) User(ID portainer.UserID) (*portainer.User, error)

User returns a user by ID

func (*Service) UserByUsername

func (service *Service) UserByUsername(username string) (*portainer.User, error)

UserByUsername returns a user by username.

func (*Service) Users

func (service *Service) Users() ([]portainer.User, error)

Users return an array containing all the users.

func (*Service) UsersByRole

func (service *Service) UsersByRole(role portainer.UserRole) ([]portainer.User, error)

UsersByRole return an array containing all the users with the specified role.