Starts a named OAuth2 login flow other than the client's default one. It triggers the configured oauth2 client's normal login redirect internally, then rewrites the Location header and the body of that redirect so the browser is sent to triggerFlow instead of the client's defaultFlow, merging in any configured login parameters.

Syntax

flowInitiator:
  '$ref': <string>
  afterLoginUrl: <string>
  defaultFlow: <string>
  loginParameters:
    - <loginParameter>
  logoutBeforeFlow: <boolean>
  oauth2: <string>
  triggerFlow: <string>

flowInitiator:
  '$ref': <string>
  afterLoginUrl: <string>
  defaultFlow: <string>
  loginParameters:
    - <loginParameter>
  logoutBeforeFlow: <boolean>
  oauth2: <string>
  triggerFlow: <string>

Attributes

Name	Required	Default	Description	Examples
$ref	false	-	Reference a component defined under components.	-
afterLoginUrl	false	-	URL the request is rewritten to before the oauth2 client builds its login redirect.	-
defaultFlow	false	-	Name of the client's default flow, as it appears in the generated redirect, to be replaced with `triggerFlow`.	-
logoutBeforeFlow	false	true	Whether any existing session is logged out before starting the flow.	-
oauth2	false	-	The `oauth2` client interceptor whose login redirect is triggered and rewritten.	-
triggerFlow	false	-	Name of the OAuth2 flow to redirect the browser to instead of the client's default flow.	-

Child Structure

Element	Cardinality	Description
loginParameter	0..*	Parameters added to the login redirect. A `loginParameter` with a `value` contributes that constant, one without forwards the incoming request's query parameter of the same name, if it is present.

Can be used in

components interceptor