types

Documentation

Index

• type AuthorizationParamters
• type CodeExchangeParameters
• type ConfigParameters

Types

type AuthorizationParamters

type AuthorizationParamters struct {
	// State is the state that's preserved across the authorization.
	State string
	// CodeChallenge is the PKCE code challenge used to compare against
	// the one supplied during exchange. OIDC only.
	CodeChallenge string
	// Nonce is the single use value required by OIDC that's encoded
	// in the id_token.  OIDC only.
	Nonce string
	// Email address of the user, used to inject the login_hint.
	// OIDC only.
	Email string
}

AuthorizationParamters are common parameters when starting the oauth2 authorization code flow.

type CodeExchangeParameters

type CodeExchangeParameters struct {
	// ConfigParameters are used to contact the authorization server
	// and also for ID token validation when using OIDC.
	ConfigParameters
	// Code is the code returned by the authorization server.
	Code string
	// CodeVerifier is the corresponding key to the authorization code
	// challenge that proves we requested the token.
	CodeVerifier string
	// SkipIssuerCheck is a hack for non-compliant providers like
	// microsoft.  OIDC only.
	SkipIssuerCheck bool
}

CodeExchangeParameters are common parameters when performing the oauth2 code exchange.

type ConfigParameters

type ConfigParameters struct {
	// Host is the current HTTP 1.1 hostname.
	Host string
	// Provider describes the oauth2 provider.
	Provider *unikornv1.OAuth2Provider
}

ConfigParameters are common parameters when creating an oauth2 client.