OAuth Providers
Obtain access tokens to Keycloak accounts with Handshake.

How it works

With your instance deployed, simply redirect users to:


Where HANDLER_ID is either keycloak or the value passed to the optional id argument of the Keycloak() factory. (See Usage below.)

Handshake will take the user through the Keycloak OAuth flow and redirect them back to the URL specified by the callback_uri query parameter.


Modify your app/options.ts file to include the Keycloak() handler like so:

import { Keycloak, HandshakeOptions } from "handshake";
const config: HandshakeOptions = {
  handlers: [
      clientId: string,
      clientSecret: string,
// ...

Adapted from next-auth.

Consult the reference to learn about HandshakeOptions.


Having an issue making Keycloak work? Open an issue in our Github repo to get help from our team.