openid

Documentation

Overview

Package openid provides identity providers that use OpenID to determine the identity.

Index

• func NewOpenIDConnectIdentityProvider(params OpenIDConnectParams) idp.IdentityProvider
• type OpenIDConnectParams

Functions

func NewOpenIDConnectIdentityProvider

func NewOpenIDConnectIdentityProvider(params OpenIDConnectParams) idp.IdentityProvider

NewOpenIDConnectIdentityProvider creates a new identity provider using OpenID connect.

Types

type OpenIDConnectParams

type OpenIDConnectParams 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"`

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

	// Issuer is the OpenID connect issuer for the identity provider.
	// Discovery will be performed for this issuer.
	Issuer string `yaml:"issuer"`

	// Scopes contains the OAuth scopes to request.
	Scopes []string `yaml:"scopes"`

	// ClientID is the ID of the client as registered with the issuer.
	ClientID string `yaml:"client-id"`

	// ClientSecret is a client specific secret agreed with the issuer.
	ClientSecret string `yaml:"client-secret"`
}