authorizedkeys

README

Authorized Keys module

Note: The reset command is not supported in the Authorized Keys module, you must delete and re-create a user's key file.

$ userplex authorizedkeys --help
NAME:
   userplex authorizedkeys - Operations within authorizedkeys files

USAGE:
   userplex authorizedkeys command [command options] [arguments...]

COMMANDS:
   create  Create user
   reset   Reset user credentials
   delete  Delete user
   sync    Run sync operation
   verify  Verify users against Person API. Outputs report, use `sync` to fix discrepancies.

OPTIONS:
   --help, -h  show help

Documentation

Index

• type AuthorizedKeysModule
  • func New(c modules.AuthorizedKeysConfiguration, ...) *AuthorizedKeysModule
  • func (akm *AuthorizedKeysModule) Create(username string, person *person_api.Person) error
  • func (akm *AuthorizedKeysModule) Delete(username string) error
  • func (akm *AuthorizedKeysModule) ModuleName() string
  • func (akm *AuthorizedKeysModule) NewFromInterface(config modules.Configuration, notificationsConfig notifications.Config, ...) modules.Module
  • func (akm *AuthorizedKeysModule) Reset(username string, person *person_api.Person) error
  • func (akm *AuthorizedKeysModule) Sync() error
  • func (akm *AuthorizedKeysModule) Verify() error

Types

type AuthorizedKeysModule

type AuthorizedKeysModule struct {
	*modules.BaseModule
	// contains filtered or unexported fields
}

func New

func New(c modules.AuthorizedKeysConfiguration, notificationsConfig notifications.Config, PersonClient *person_api.Client) *AuthorizedKeysModule

func (*AuthorizedKeysModule) Create

func (akm *AuthorizedKeysModule) Create(username string, person *person_api.Person) error

func (*AuthorizedKeysModule) Delete

func (akm *AuthorizedKeysModule) Delete(username string) error

func (*AuthorizedKeysModule) ModuleName

func (akm *AuthorizedKeysModule) ModuleName() string

func (*AuthorizedKeysModule) NewFromInterface

func (akm *AuthorizedKeysModule) NewFromInterface(config modules.Configuration, notificationsConfig notifications.Config, PersonClient *person_api.Client) modules.Module

func (*AuthorizedKeysModule) Reset

func (akm *AuthorizedKeysModule) Reset(username string, person *person_api.Person) error

func (*AuthorizedKeysModule) Sync

func (akm *AuthorizedKeysModule) Sync() error

func (*AuthorizedKeysModule) Verify

func (akm *AuthorizedKeysModule) Verify() error