public interface OAuth2Auth extends AuthProvider
AuthProvider instances.| Modifier and Type | Method and Description |
|---|---|
String |
authorizeURL(JsonObject params)
Generate a redirect URL to the authN/Z backend.
|
static OAuth2Auth |
create(Vertx vertx)
Create a OAuth2 auth provider
|
static OAuth2Auth |
create(Vertx vertx,
OAuth2ClientOptions config)
Create a OAuth2 auth provider
|
default Future<AccessToken> |
decodeToken(String token)
Decode a token to a
AccessToken object. |
OAuth2Auth |
decodeToken(String token,
Handler<AsyncResult<AccessToken>> handler)
Decode a token to a
AccessToken object. |
OAuth2FlowType |
getFlowType()
Returns the configured flow type for the Oauth2 provider.
|
default Future<AccessToken> |
introspectToken(String token)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
default OAuth2Auth |
introspectToken(String token,
Handler<AsyncResult<AccessToken>> handler)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
OAuth2Auth |
introspectToken(String token,
String tokenType,
Handler<AsyncResult<AccessToken>> handler)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
default Future<Void> |
loadJWK()
Loads a JWK Set from the remote provider.
|
OAuth2Auth |
loadJWK(Handler<AsyncResult<Void>> handler)
Loads a JWK Set from the remote provider.
|
OAuth2Auth |
rbacHandler(OAuth2RBAC rbac) |
authenticate, authenticatestatic OAuth2Auth create(Vertx vertx)
vertx - the Vertx instancestatic OAuth2Auth create(Vertx vertx, OAuth2ClientOptions config)
vertx - the Vertx instanceconfig - the configString authorizeURL(JsonObject params)
OAuth2Auth decodeToken(String token, Handler<AsyncResult<AccessToken>> handler)
AccessToken object. This is useful to handle bearer JWT tokens.token - the access token (base64 string)handler - A handler to receive the eventdefault Future<AccessToken> decodeToken(String token)
AccessToken object. This is useful to handle bearer JWT tokens.token - the access token (base64 string)decodeToken(String, Handler)default OAuth2Auth introspectToken(String token, Handler<AsyncResult<AccessToken>> handler)
token - the access token (base64 string)handler - A handler to receive the eventdefault Future<AccessToken> introspectToken(String token)
token - the access token (base64 string)introspectToken(String, Handler)OAuth2Auth introspectToken(String token, String tokenType, Handler<AsyncResult<AccessToken>> handler)
token - the access token (base64 string)tokenType - hint to the token type e.g.: `access_token`handler - A handler to receive the eventOAuth2FlowType getFlowType()
OAuth2Auth loadJWK(Handler<AsyncResult<Void>> handler)
default Future<Void> loadJWK()
loadJWK(Handler)OAuth2Auth rbacHandler(OAuth2RBAC rbac)
Copyright © 2019 Eclipse. All rights reserved.