io.vertx.ext.auth.oauth2.providers

Interface OpenIDConnectAuth

All Known Subinterfaces:

AmazonCognitoAuth, AzureADAuth, GoogleAuth, IBMCloudAuth, KeycloakAuth, SalesforceAuth

public interface OpenIDConnectAuth

Simplified factory to create an OAuth2Auth for OpenID Connect.

Author:

Paulo Lopes

Method Summary

Modifier and Type	Method and Description
static Future<OAuth2Auth>	discover(Vertx vertx, OAuth2Options config) Create a OAuth2Auth provider for OpenID Connect Discovery.
static void	discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler) Create a OAuth2Auth provider for OpenID Connect Discovery.

Method Detail

discover

static void discover(Vertx vertx,
                     OAuth2Options config,
                     Handler<AsyncResult<OAuth2Auth>> handler)

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the given site in the configuration options and attempt to load the well known descriptor.

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:

vertx - the vertx instance

config - the initial config, it should contain a site url

handler - the instantiated Oauth2 provider instance handler

discover

static Future<OAuth2Auth> discover(Vertx vertx,
                                   OAuth2Options config)

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the given site in the configuration options and attempt to load the well known descriptor.

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:

vertx - the vertx instance

config - the initial config, it should contain a site url

Returns:

future with the instantiated Oauth2 provider instance handler

See Also:

discover(Vertx, OAuth2Options, Handler)