idprovider

Documentation

Index

• Variables
• func RegisterIdentityProvider(key string, provider Provider)
• func RegisterProviderFactory(factory ProviderFactory)
• type Identity
• type Provider
  • func GetIdentityProvider(key string) (Provider, error)
• type ProviderFactory

Variables

var (

	// ErrIdentityProviderNotFound error in not found identity provider.
	ErrIdentityProviderNotFound = errors.New("identity provider not found")
)

tenantID:provider.

Functions

func RegisterIdentityProvider

func RegisterIdentityProvider(key string, provider Provider)

RegisterIdentityProvider register Provider with key.

func RegisterProviderFactory

func RegisterProviderFactory(factory ProviderFactory)

RegisterProviderFactory registers ProviderFactory with the specified type.

Types

type Identity

type Identity interface {
	// Identifier for the End-User.
	GetUserID() string
	// User's tenant info at needed.
	GetTenantID() string
	// The username which the End-User wishes to be referred to panda.
	GetUsername() string
	// Email user's email info at needed.
	GetEmail() string
	// External idprovider unique user id.
	GetExternalID() string
	// Other extensions.
	GetExtra() map[string]any
}

Identity represents the account mapped to this system.

type Provider

type Provider interface {
	// Type unique type of the provider.
	Type() string
	// AuthenticateCode authenticate identity with code from remote server.
	AuthenticateCode(code string) (Identity, error)
	// Authenticate basic authn username password.
	Authenticate(username string, password string) (Identity, error)
	AuthCodeURL(state, nonce string) string
}

func GetIdentityProvider

func GetIdentityProvider(key string) (Provider, error)

GetIdentityProvider returns identity Provider with key.

type ProviderFactory

type ProviderFactory interface {
	// Type unique type of the provider.
	Type() string
	// Apply the  options from external identity provider config.
	Create(options map[string]any) (Provider, error)
}