admin

Documentation

Overview

package admin provides an implementation of the API described in auth/schema/adminschema.

Index

• Variables
• type AdminAPI
  • func NewAdminAPI(userRepo user.UserRepo, pwiRepo user.PasswordInfoRepo, ...) *AdminAPI
  • func (a *AdminAPI) CreateAdmin(admn adminschema.Admin) (string, error)
  • func (a *AdminAPI) CreateClient(req adminschema.ClientCreateRequest) (adminschema.ClientCreateResponse, error)
  • func (a *AdminAPI) GetAdmin(id string) (adminschema.Admin, error)
  • func (a *AdminAPI) GetState() (adminschema.State, error)
• type Error
  • func (e Error) Error() string

Variables

var (
	ErrorMissingClient = errorMaker("bad_request", "The 'client' cannot be empty", http.StatusBadRequest)(nil)

	// Called when oidc.ClientMetadata.Valid() fails.
	ErrorInvalidClientFunc = errorMaker("bad_request", "Your client could not be validated.", http.StatusBadRequest)
)

var (
	ClientIDGenerator = oidc.GenClientID
)

Types

type AdminAPI

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

AdminAPI provides the logic necessary to implement the Admin API.

func NewAdminAPI

func NewAdminAPI(userRepo user.UserRepo, pwiRepo user.PasswordInfoRepo, clientRepo client.ClientRepo, userManager *manager.UserManager, localConnectorID string) *AdminAPI

func (*AdminAPI) CreateAdmin

func (a *AdminAPI) CreateAdmin(admn adminschema.Admin) (string, error)

func (*AdminAPI) CreateClient

func (a *AdminAPI) CreateClient(req adminschema.ClientCreateRequest) (adminschema.ClientCreateResponse, error)

func (*AdminAPI) GetAdmin

func (a *AdminAPI) GetAdmin(id string) (adminschema.Admin, error)

func (*AdminAPI) GetState

func (a *AdminAPI) GetState() (adminschema.State, error)

type Error

type Error struct {
	Type string

	// The HTTP Code to return for this type of error.
	Code int

	Desc string

	// The underlying error - not to be consumed by external users.
	Internal error
}

Error is the error type returned by AdminAPI methods.

func (Error) Error

func (e Error) Error() string