Module: vertx-auth-oauth2-js/keycloak_auth

Classes

KeycloakAuth

Methods

(static) KeycloakAuth.create(vertx, flow, config, httpClientOptions) → {OAuth2Auth}

Create a OAuth2Auth provider for Keycloak
Parameters:
Name Type Description
vertx Vertx
flow Object the oauth2 flow to use
config Object the json config file exported from Keycloak admin console
httpClientOptions Object custom http client options
Source:
Returns:
Type
OAuth2Auth

(static) KeycloakAuth.discover(vertx, config, handler)

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Parameters:
Name Type Description
vertx Vertx the vertx instance
config Object the initial config
handler function the instantiated Oauth2 provider instance handler
Source: