keycloak

Documentation

Overview

Package keycloak offers an invitation backend for the invitation service.

Index

• type Backend
  • func New(logger log.Logger, ...) *Backend
  • func NewWithClient(logger log.Logger, client keycloak.Client, userRealm string) *Backend
  • func (b Backend) CanSendMail() bool
  • func (b Backend) CreateUser(ctx context.Context, invitation *invitations.Invitation) (string, error)
  • func (b Backend) SendMail(ctx context.Context, id string) error
• type GoCloak

Types

type Backend

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

Backend represents the keycloak backend.

func New

func New(
	logger log.Logger,
	baseURL, clientID, clientSecret, clientRealm, userRealm string,
	insecureSkipVerify bool,
) *Backend

New instantiates a new keycloak.Backend with a default gocloak client.

func NewWithClient

func NewWithClient(
	logger log.Logger,
	client keycloak.Client,
	userRealm string,
) *Backend

NewWithClient creates a new backend with the supplied keycloak client.

func (Backend) CanSendMail

func (b Backend) CanSendMail() bool

CanSendMail returns true because keycloak does allow sending mail.

func (Backend) CreateUser

func (b Backend) CreateUser(ctx context.Context, invitation *invitations.Invitation) (string, error)

CreateUser creates a user in the keycloak backend.

func (Backend) SendMail

func (b Backend) SendMail(ctx context.Context, id string) error

SendMail sends a mail to the user with details on how to redeem the invitation.

type GoCloak

type GoCloak interface {
	CreateUser(ctx context.Context, token, realm string, user gocloak.User) (string, error)
	ExecuteActionsEmail(ctx context.Context, token, realm string, params gocloak.ExecuteActionsEmail) error
	LoginClient(ctx context.Context, clientID, clientSecret, realm string) (*gocloak.JWT, error)
	RetrospectToken(ctx context.Context, accessToken, clientID, clientSecret, realm string) (*gocloak.IntroSpectTokenResult, error)
}

GoCloak represents the parts of gocloak.GoCloak that we use, mainly here for mockery.