redirector

Documentation

Index

• Constants
• func NewChallenger(baseRequestURL *url.URL, redirectURL string) oauthhandlers.AuthenticationChallenger
• func NewRedirector(baseRequestURL *url.URL, redirectURL string) oauthhandlers.AuthenticationRedirector

Constants

const (
	// URLToken in the query of the redirectURL gets replaced with the original request URL, escaped as a query parameter.
	// Example use: https://www.example.com/login?then=${url}
	URLToken = "${url}"

	// QueryToken in the query of the redirectURL gets replaced with the original request URL, unescaped.
	// Example use: https://www.example.com/sso/oauth/authorize?${query}
	QueryToken = "${query}"
)

Functions

func NewChallenger

func NewChallenger(baseRequestURL *url.URL, redirectURL string) oauthhandlers.AuthenticationChallenger

NewChallenger returns an oauthhandlers.AuthenticationChallenger that returns a Location header to the specified redirectURL. Request URLs missing scheme/host, or with relative paths are resolved relative to the baseRequestURL, if specified. The following tokens are replaceable in the query of the redirectURL:

${url} is replaced with the current request URL, escaped as a query parameter. Example: https://www.example.com/login?then=${url}
${query} is replaced with the current request query, unescaped. Example: https://www.example.com/sso/oauth/authorize?${query}

func NewRedirector

func NewRedirector(baseRequestURL *url.URL, redirectURL string) oauthhandlers.AuthenticationRedirector

NewRedirector returns an oauthhandlers.AuthenticationRedirector that redirects to the specified redirectURL. Request URLs missing scheme/host, or with relative paths are resolved relative to the baseRequestURL, if specified. The following tokens are replaceable in the query of the redirectURL:

${url} is replaced with the current request URL, escaped as a query parameter. Example: https://www.example.com/login?then=${url}
${query} is replaced with the current request query, unescaped. Example: https://www.example.com/sso/oauth/authorize?${query}