install

Installs an OAuth2Flow into the routing tree.

Creates the configured callback route and login route at OAuth2Flow.loginPath. Unauthenticated requests to either route redirect to the OAuth provider.

Report a problem

Parameters

flow

OAuth 2.0 flow to install.


Installs an OAuth2SessionFlow into the routing tree.

Creates the configured callback route and login route at OAuthFlowConfigBase.loginPath. Also installs the Sessions plugin for OAuth2SessionFlow.session.

Unauthenticated requests to the callback path or OAuthFlowConfigBase.loginPath redirect to the OAuth provider. Routes protected later with authenticateWith using OAuth2SessionFlow.session are not covered by this redirect; they respond with 401 Unauthorized when no valid session exists.

For ID-based session transports, the callback stores the authenticated session under a freshly generated session ID. Any session ID arriving with the callback request is invalidated to prevent session fixation.

Report a problem

Parameters

oauth

OAuth 2.0 flow with typed session authentication.


Installs an OAuth2Flow at the application routing root.

Equivalent to application.routing { install(flow) }.

Report a problem


Installs an OAuth2SessionFlow at the application routing root.

Equivalent to application.routing { install(flow) }.

Report a problem


Installs the Sessions plugin for session on this route.

This is used by integrations that own their route subtree and want the typed session scheme to install its configured transport automatically.

Report a problem

Parameters

session

typed session authentication scheme whose transport configuration is applied.

Throws

when Sessions cannot be installed for this scheme.


Installs the Sessions plugin for sessions at the application routing root.

Equivalent to application.routing { install(sessions) }.

Report a problem

Parameters

sessions

typed session authentication scheme whose transport configuration is applied.