usermanager

package
v0.0.0-...-8ff1004 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2019 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UserManagerAPI

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

UserManagerAPI implements the user manager interface and is the concrete implementation of the api end point.

func NewUserManagerAPI

func NewUserManagerAPI(
	st *state.State,
	resources facade.Resources,
	authorizer facade.Authorizer,
) (*UserManagerAPI, error)

NewUserManagerAPI provides the signature required for facade registration.

func (*UserManagerAPI) AddUser

func (api *UserManagerAPI) AddUser(args params.AddUsers) (params.AddUserResults, error)

AddUser adds a user with a username, and either a password or a randomly generated secret key which will be returned.

func (*UserManagerAPI) DisableUser

func (api *UserManagerAPI) DisableUser(users params.Entities) (params.ErrorResults, error)

DisableUser disables one or more users. If the user is already disabled, the action is considered a success.

func (*UserManagerAPI) EnableUser

func (api *UserManagerAPI) EnableUser(users params.Entities) (params.ErrorResults, error)

EnableUser enables one or more users. If the user is already enabled, the action is considered a success.

func (*UserManagerAPI) RemoveUser

func (api *UserManagerAPI) RemoveUser(entities params.Entities) (params.ErrorResults, error)

RemoveUser permanently removes a user from the current controller for each entity provided. While the user is permanently removed we keep it's information around for auditing purposes. TODO(redir): Add information about getting deleted user information when we add that capability.

func (*UserManagerAPI) ResetPassword

func (api *UserManagerAPI) ResetPassword(args params.Entities) (params.AddUserResults, error)

ResetPassword resets password for supplied users by invalidating current passwords (if any) and generating new random secret keys which will be returned. Users cannot reset their own password.

func (*UserManagerAPI) SetPassword

func (api *UserManagerAPI) SetPassword(args params.EntityPasswords) (params.ErrorResults, error)

SetPassword changes the stored password for the specified users.

func (*UserManagerAPI) UserInfo

UserInfo returns information on a user.

Jump to

Keyboard shortcuts

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