keycloak

Documentation

Overview

Package keycloak is an identity provider that authenticates with keycloak oidc.

Index

• func NewIdentityProvider(p Params) idp.IdentityProvider
• type Params

Functions

func NewIdentityProvider

func NewIdentityProvider(p Params) idp.IdentityProvider

NewIdentityProvider creates a keycloak identity provider with the configuration defined by p.

Types

type Params

type Params struct {
	// Name is the name that will be given to the identity provider.
	Name string `yaml:"name"`

	// Description is the description that will be used with the
	// identity provider. If this is not set then Name will be used.
	Description string `yaml:"description"`

	// Icon contains the URL or path of an icon.
	Icon string `yaml:"icon"`

	// Domain is the domain with which all identities created by this
	// identity provider will be tagged (not including the @ separator).
	Domain string `yaml:"domain"`

	// ClientID contains the Application Id for the application
	// registered
	ClientID string `yaml:"client-id"`

	// Optional: ClientSecret contains a password type Application Secret
	// for the application generated
	ClientSecret string `yaml:"client-secret"`

	// KeycloakReam contains the URI for the keycloak server
	// https://<keycloakserver>/auth/realms/<keycloakdomain>
	KeycloakRealm string `yaml:"keycloak-realm"`

	// Hidden is set if the IDP should be hidden from interactive
	// prompts.
	Hidden bool `yaml:"hidden"`
}

Params is a struct containing the configuration data to register a keycloak identity Provider