public interface OAuth2AuthHandler extends AuthenticationHandler
Modifier and Type | Method and Description |
---|---|
static OAuth2AuthHandler |
create(Vertx vertx,
OAuth2Auth authProvider)
Create a OAuth2 auth handler without host pinning.
|
static OAuth2AuthHandler |
create(Vertx vertx,
OAuth2Auth authProvider,
String callbackURL)
Create a OAuth2 auth handler with host pinning
|
OAuth2AuthHandler |
extraParams(JsonObject extraParams)
Extra parameters needed to be passed while requesting a token.
|
OAuth2AuthHandler |
pkceVerifierLength(int length)
PKCE (RFC 7636) is an extension to the Authorization Code flow to prevent several attacks and to be able to
securely perform the OAuth exchange from public clients.
|
OAuth2AuthHandler |
prompt(String prompt)
Indicates the type of user interaction that is required.
|
OAuth2AuthHandler |
setupCallback(Route route)
add the callback handler to a given route.
|
OAuth2AuthHandler |
withScope(String scope)
Return a new instance with the internal state copied from the caller but the scopes to be requested during a token
request are unique to the instance.
|
OAuth2AuthHandler |
withScopes(List<String> scopes)
Return a new instance with the internal state copied from the caller but the scopes to be requested during a token
request are unique to the instance.
|
static OAuth2AuthHandler create(Vertx vertx, OAuth2Auth authProvider, String callbackURL)
vertx
- the vertx instanceauthProvider
- the auth provider to usecallbackURL
- the callback URL you entered in your provider admin console, usually it should be something like: `https://myserver:8888/callback`static OAuth2AuthHandler create(Vertx vertx, OAuth2Auth authProvider)
vertx
- the vertx instanceauthProvider
- the auth provider to useOAuth2AuthHandler extraParams(JsonObject extraParams)
extraParams
- extra optional parameters.OAuth2AuthHandler withScope(String scope)
scope
- scope.OAuth2AuthHandler withScopes(List<String> scopes)
scopes
- scopes.OAuth2AuthHandler prompt(String prompt)
prompt
- the prompt choice.OAuth2AuthHandler pkceVerifierLength(int length)
length
- A number between 43 and 128. Or -1 to disable.OAuth2AuthHandler setupCallback(Route route)
route
- a given route e.g.: `/callback`Copyright © 2021 Eclipse. All rights reserved.