providers

Documentation

Index

• type Generic
  • func (p *Generic) ClientConfig() (*clientcredentials.Config, error)
  • func (p *Generic) GetAuthURL() string
  • func (p *Generic) GetAuthURLExternal() string
  • func (p *Generic) GetCertURL() string
  • func (p *Generic) GetClientID() string
  • func (p *Generic) GetClientIDExternal() string
  • func (p *Generic) GetClientSecret() string
  • func (p *Generic) GetClientSecretExternal() string
  • func (p *Generic) GetIntrospectURL() string
  • func (p *Generic) GetLogoutURL() string
  • func (p *Generic) GetLogoutURLExternal() string
  • func (p *Generic) GetScopes() []string
  • func (p *Generic) GetTokenURL() string
  • func (p *Generic) GetTokenURLExternal() string

Types

type Generic

type Generic struct {

	// ClientID is the application's ID.
	ClientID string `cfg:"client_id"`

	// ClientIDExternal for reaching the client id from outside.
	ClientIDExternal string `cfg:"client_id_external"`

	// ClientSecret is the application's secret.
	ClientSecret string `cfg:"client_secret" log:"false"`

	// ClientSecretExternal for reaching the client secret from outside.
	ClientSecretExternal string `cfg:"client_secret_external"`

	// Scope specifies optional requested permissions.
	Scopes []string `cfg:"scopes"`

	// CertURL is the resource server's public key URL.
	//
	// BaseURL and REALM are used to construct the CertURL.
	CertURL string `cfg:"cert_url"`

	// IntrospectURL is the check the active or not with request.
	IntrospectURL string `cfg:"introspect_url"`

	// AuthURL is the resource server's authorization endpoint
	// use for redirection to login page.
	//
	// BaseURL and REALM are used to construct the AuthURL.
	AuthURL string `cfg:"auth_url"`

	// AuthURLExternal for reaching the auth page from outside.
	//
	// Default is AuthURL.
	AuthURLExternal string `cfg:"auth_url_external"`

	// TokenURL is the resource server's token endpoint
	// URL. This is a constant specific to each server.
	//
	// BaseURL and REALM are used to construct the TokenURL.
	TokenURL string `cfg:"token_url"`

	// TokenURLExternal for reaching the token page from outside.
	//
	// Default is TokenURL.
	TokenURLExternal string `cfg:"token_url_external"`

	LogoutURL string `cfg:"logout_url"`
	// LogoutURLExternal for reaching the logout url from outside.
	// Default is LogoutURL.
	LogoutURLExternal string `cfg:"logout_url_external"`
}

func (*Generic) ClientConfig

func (p *Generic) ClientConfig() (*clientcredentials.Config, error)

func (*Generic) GetAuthURL

func (p *Generic) GetAuthURL() string

func (*Generic) GetAuthURLExternal

func (p *Generic) GetAuthURLExternal() string

func (*Generic) GetCertURL

func (p *Generic) GetCertURL() string

func (*Generic) GetClientID

func (p *Generic) GetClientID() string

func (*Generic) GetClientIDExternal

func (p *Generic) GetClientIDExternal() string

func (*Generic) GetClientSecret

func (p *Generic) GetClientSecret() string

func (*Generic) GetClientSecretExternal

func (p *Generic) GetClientSecretExternal() string

func (*Generic) GetIntrospectURL

func (p *Generic) GetIntrospectURL() string

func (*Generic) GetLogoutURL

func (p *Generic) GetLogoutURL() string

func (*Generic) GetLogoutURLExternal

func (p *Generic) GetLogoutURLExternal() string

func (*Generic) GetScopes

func (p *Generic) GetScopes() []string

func (*Generic) GetTokenURL

func (p *Generic) GetTokenURL() string

func (*Generic) GetTokenURLExternal

func (p *Generic) GetTokenURLExternal() string