adfs

Documentation

Overview

Package adfs is an identity provider that authenticates with an ADFS service.

Index

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

Functions

func NewIdentityProvider

func NewIdentityProvider(p Params) idp.IdentityProvider

NewIdentityProvider creates an ADFS 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"`

	// URL is the URL of the Active Directory Federation Services
	// instance that is used to provide identities. OpenID Connect
	// discovery will be run on this URL to determine the required
	// service parameters.
	URL string `yaml:"url"`

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

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

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

	// MatchEmailAddr is a regular expression that is used to determine if
	// this identity provider can be used for a particular user email.
	MatchEmailAddr string `yaml:"match-email-addr"`
}