Skip navigation links
A B C D E F G H I J K L M N O P R S T U V 

A

AccessToken - Interface in io.vertx.ext.auth.oauth2
Deprecated.
accessToken() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
The Access Token if present parsed as a JsonObject
accessToken(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
Get decoded `access_token` from the principal.
acr(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
addPubSecKey(PubSecKeyOptions) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
allowedOrigins(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
AmazonCognitoAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Amazon Cognito.
authorizeURL(JsonObject) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
The client sends the end-user's browser to this endpoint to request their authentication and consent.
authTime(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
AzureADAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Azure AD.

B

body() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
The HTTP response body as a buffer
BoxAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for box.com.

C

checkValid(V) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
CloudFoundryAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for CloudFoundry UAA.
create() - Static method in interface io.vertx.ext.auth.oauth2.authorization.KeycloakAuthorization
Factory method to create an Authorization Provider for tokens adhering to the Keycloak token format.
create(String) - Static method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Factory method to create a Authorization provider for Oauth 2.0 scopes.
create(Vertx) - Static method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Create a OAuth2 auth provider
create(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Create a OAuth2 auth provider
create(Vertx, String, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth
Create a OAuth2Auth provider for Amazon Cognito
create(Vertx, String, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth
Create a OAuth2Auth provider for Amazon Cognito
create(Vertx, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.AzureADAuth
Create a OAuth2Auth provider for Microsoft Azure Active Directory
create(Vertx, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.AzureADAuth
Create a OAuth2Auth provider for Microsoft Azure Active Directory
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.BoxAuth
Create a OAuth2Auth provider for App.net
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.BoxAuth
Create a OAuth2Auth provider for App.net
create(Vertx, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.CloudFoundryAuth
Create a OAuth2Auth provider for CloudFoundry UAA
create(Vertx, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.CloudFoundryAuth
Create a OAuth2Auth provider for CloudFoundry UAA
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.DropboxAuth
Create a OAuth2Auth provider for Dropbox
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.DropboxAuth
Create a OAuth2Auth provider for Dropbox
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.FacebookAuth
Create a OAuth2Auth provider for Facebook
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.FacebookAuth
Create a OAuth2Auth provider for Facebook
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.FoursquareAuth
Create a OAuth2Auth provider for Foursquare
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.FoursquareAuth
Create a OAuth2Auth provider for Foursquare
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.GithubAuth
Create a OAuth2Auth provider for Github
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.GithubAuth
Create a OAuth2Auth provider for Github
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.GitLabAuth
Create a OAuth2Auth provider for GitLab.com.
create(Vertx, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.GitLabAuth
Create a OAuth2Auth provider for GitLab.
create(Vertx, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.GitLabAuth
Create a OAuth2Auth provider for GitLab.
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for Google
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for Google
create(Vertx, JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for Google Service Account (Server to Server)
create(Vertx, JsonObject, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for Google Service Account (Server to Server)
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.HerokuAuth
Create a OAuth2Auth provider for Heroku
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.HerokuAuth
Create a OAuth2Auth provider for Heroku
create(Vertx, String, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.IBMCloudAuth
Create a OAuth2Auth provider for IBM Cloud
create(Vertx, String, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.IBMCloudAuth
Create a OAuth2Auth provider for IBM Cloud
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.InstagramAuth
Create a OAuth2Auth provider for Instagram
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.InstagramAuth
Create a OAuth2Auth provider for Instagram
create(Vertx, JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for Keycloak
create(Vertx, OAuth2FlowType, JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for Keycloak
create(Vertx, JsonObject, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for Keycloak
create(Vertx, OAuth2FlowType, JsonObject, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for Keycloak
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.LinkedInAuth
Create a OAuth2Auth provider for LinkedIn
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.LinkedInAuth
Create a OAuth2Auth provider for LinkedIn
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.LiveAuth
Create a OAuth2Auth provider for live.com
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.LiveAuth
Create a OAuth2Auth provider for live.com
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.MailchimpAuth
Create a OAuth2Auth provider for Mailchimp
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.MailchimpAuth
Create a OAuth2Auth provider for Mailchimp
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.SalesforceAuth
Create a OAuth2Auth provider for Salesforce
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.SalesforceAuth
Create a OAuth2Auth provider for Salesforce
create(Vertx, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.ShopifyAuth
Create a OAuth2Auth provider for Shopify
create(Vertx, String, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.ShopifyAuth
Create a OAuth2Auth provider for Shopify
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.SoundcloudAuth
Create a OAuth2Auth provider for SoundCloud
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.SoundcloudAuth
Create a OAuth2Auth provider for SoundCloud
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.StripeAuth
Create a OAuth2Auth provider for Stripe
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.StripeAuth
Create a OAuth2Auth provider for Stripe
create(Vertx, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.TwitterAuth
Create a OAuth2Auth provider for Twitter
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.TwitterAuth
Create a OAuth2Auth provider for Twitter
create(OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.rbac.KeycloakRBAC
Factory method to create a RBAC handler for tokens adhering to the Keycloak token format.
create() - Static method in interface io.vertx.ext.auth.oauth2.rbac.MicroProfileRBAC
Factory method to create a RBAC handler for tokens adhering to the MP-JWT 1.1 spec.

D

decodeToken(String, Handler<AsyncResult<AccessToken>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
decodeToken(String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.AzureADAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.AzureADAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.GoogleAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.IBMCloudAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.IBMCloudAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options, Handler<AsyncResult<OAuth2Auth>>) - Static method in interface io.vertx.ext.auth.oauth2.providers.SalesforceAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
discover(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.SalesforceAuth
Create a OAuth2Auth provider for OpenID Connect Discovery.
DropboxAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Dropbox.

E

email(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
encode(List<String>) - Method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Returns a String with the given scopes concatenated with the given separator.
endSessionURL(User, JsonObject) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
endSessionURL(User) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.

F

FacebookAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Facebook.
fetch(String, Handler<AsyncResult<OAuth2Response>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Fetches a JSON resource using this Access Token.
fetch(String) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Fetches a JSON resource using this Access Token.
fetch(HttpMethod, String, JsonObject, Buffer, Handler<AsyncResult<OAuth2Response>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Fetches a JSON resource using this Access Token.
fetch(HttpMethod, String, JsonObject, Buffer) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Fetches a JSON resource using this Access Token.
FoursquareAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Foursquare.
fromJson(Iterable<Map.Entry<String, Object>>, OAuth2Options) - Static method in class io.vertx.ext.auth.oauth2.OAuth2OptionsConverter
 

G

getAuthorizationPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the Oauth2 authorization resource path.
getClientID() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the provider client id
getClientSecret() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the provider client secret
getClientSecretParameterName() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
When a provider uses a non standard HTTP form field name, the client secret can be overriden here.
getCode() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getExtra() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getExtraParameters() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Extra parameters to send to the provider
getFlow() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getFlowType() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
getGrantType() - Method in enum io.vertx.ext.auth.oauth2.OAuth2FlowType
 
getHeader(String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
Looks up a HTTP response header by name, in case where the response is a list of headers, the first one is returned.
getHeaders() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Custom headers to send along with every request.
getHttpClientOptions() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getIntrospectionPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider token introspection resource path
getJwkPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getJWTOptions() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getLogoutPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider logout path
getPubSecKeys() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider PubSec key options
getRedirectUri() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getRevocationPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the Oauth2 revocation resource path.
getScopeSeparator() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider scope separator
getSite() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getTenant() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getTokenPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the Oauth2 token resource path.
getUserAgent() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The User-Agent header to use when communicating with a provider
getUserInfoParameters() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider custom userInfo parameters to send when requesting them.
getUserInfoPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider userInfo resource path
GithubAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Github.
GitLabAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for GitLab.com.
GoogleAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Google.

H

headers() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
The HTTP response headers from the HTTP layer.
HerokuAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Heroku.

I

IBMCloudAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for IBM Cloud.
idToken() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
The Id Token if present parsed as a JsonObject
idToken(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
Get decoded `id_token` from the principal.
InstagramAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Instagram.
introspect(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Introspect access token.
introspect() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Introspect access token.
introspect(String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Introspect access token.
introspect(String) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Introspect access token.
introspectToken(String, Handler<AsyncResult<AccessToken>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
introspectToken(String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
introspectToken(String, String, Handler<AsyncResult<AccessToken>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
introspectToken(String, String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
io.vertx.ext.auth.oauth2 - package io.vertx.ext.auth.oauth2
 
io.vertx.ext.auth.oauth2.authorization - package io.vertx.ext.auth.oauth2.authorization
 
io.vertx.ext.auth.oauth2.providers - package io.vertx.ext.auth.oauth2.providers
 
io.vertx.ext.auth.oauth2.rbac - package io.vertx.ext.auth.oauth2.rbac
 
is(String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
Helper to analize the response body.
isAuthorized(AccessToken, String, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2RBAC
Deprecated.
This method should verify if the user has the given authority and return either a boolean value or an error.
isAuthorized(AccessToken, String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2RBAC
Deprecated.
This method should verify if the user has the given authority and return either a boolean value or an error.
isScopeGranted() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Check if the access token own the required scopes to access to the resource.
isUseBasicAuthorizationHeader() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Deprecated.
this value is not considered.
isValidateIssuer() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 

J

jsonArray() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
The HTTP response body as a JsonArray
jsonObject() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
The HTTP response body as a JsonObject
jWKSet(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Retrieve the public server JSON Web Key (JWK) required to verify the authenticity of issued ID and access tokens.
jWKSet() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Retrieve the public server JSON Web Key (JWK) required to verify the authenticity of issued ID and access tokens.

K

KeycloakAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Keycloak.
KeycloakAuthorization - Interface in io.vertx.ext.auth.oauth2.authorization
Implementation of the Keycloak Authorization Provider.
KeycloakHelper - Interface in io.vertx.ext.auth.oauth2
Deprecated.
Use the User principal to access this data as this class is not guaranteed to be secure as no cryptographic signatures are verified.
KeycloakRBAC - Interface in io.vertx.ext.auth.oauth2.rbac
Implementation of the Keycloak RBAC handler.

L

LinkedInAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for LinkedIn.
LiveAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for live.com Services.
loadJWK(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
loadJWK() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
logout(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Revoke refresh token and calls the logout endpoint.
logout() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Revoke refresh token and calls the logout endpoint.

M

MailchimpAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Mailchimp.
MicroProfileRBAC - Interface in io.vertx.ext.auth.oauth2.rbac
Implementation of the Microprofile MP-JWT 1.1 RBAC based on the access token groups key.
missingKeyHandler(Handler<String>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Handled to be called when a key (mentioned on a JWT) is missing from the current config.

N

name(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
nickName(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 

O

OAuth2Auth - Interface in io.vertx.ext.auth.oauth2
Factory interface for creating OAuth2 based AuthenticationProvider instances.
Oauth2Credentials - Class in io.vertx.ext.auth.oauth2
Credentials specific to the OAuth2Auth provider
Oauth2Credentials() - Constructor for class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
Oauth2Credentials(JsonObject) - Constructor for class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
OAuth2FlowType - Enum in io.vertx.ext.auth.oauth2
OAuth2 Flows
OAuth2Options - Class in io.vertx.ext.auth.oauth2
Options describing how an OAuth2 HttpClient will make connections.
OAuth2Options() - Constructor for class io.vertx.ext.auth.oauth2.OAuth2Options
Default constructor
OAuth2Options(OAuth2Options) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2Options
Copy constructor
OAuth2Options(JsonObject) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2Options
Constructor to create an options from JSON
OAuth2OptionsConverter - Class in io.vertx.ext.auth.oauth2
Converter and mapper for OAuth2Options.
OAuth2OptionsConverter() - Constructor for class io.vertx.ext.auth.oauth2.OAuth2OptionsConverter
 
OAuth2RBAC - Interface in io.vertx.ext.auth.oauth2
Deprecated.
use the new Authorization API AuthorizationProvider
OAuth2Response - Interface in io.vertx.ext.auth.oauth2
Deprecated.
this interface was available before webclient was present, today it makes more sense to use a webclient to do http related calls.
opaqueAccessToken() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
The RAW String if available for the Access Token
opaqueIdToken() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
The RAW String if available for the Id Token
opaqueRefreshToken() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
The RAW String if available for the Refresh Token
OpenIDConnectAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for OpenID Connect.

P

parseToken(String) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
Parse the token string with base64 decoder.
preferredUsername(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 

R

rawAccessToken(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
Get raw `access_token` string from the principal.
rawIdToken(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
Get raw `id_token` string from the principal.
rbacHandler(OAuth2RBAC) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Deprecated.
refresh(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Refresh the access token
refresh() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Refresh the access token
refresh(User, Handler<AsyncResult<User>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Refresh the current User (access token).
refresh(User) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Refresh the current User (access token).
replaceVariables(boolean) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
revoke(String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Revoke access or refresh token
revoke(String) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Revoke access or refresh token
revoke(User, String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Revoke an obtained access or refresh token.
revoke(User, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Revoke an obtained access token.
revoke(User, String) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Revoke an obtained access or refresh token.
revoke(User) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Revoke an obtained access token.

S

SalesforceAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Salesforce.
ScopeAuthorization - Interface in io.vertx.ext.auth.oauth2.authorization
Scope is a mechanism in OAuth 2.0 to limit an application's access to a user's account.
separator() - Method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Returns the configured separator.
sessionState(JsonObject) - Static method in interface io.vertx.ext.auth.oauth2.KeycloakHelper
Deprecated.
 
setAuthorizationPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setClientID(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider client id
setClientSecret(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider client secret
setClientSecretParameterName(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Override the HTTP form field name for client secret
setCode(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setExtra(JsonObject) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setExtraParameters(JsonObject) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set extra parameters to be sent to the provider on each request
setFlow(OAuth2FlowType) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setHeaders(JsonObject) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set custom headers to be sent with every request to the provider
setHttpClientOptions(HttpClientOptions) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setIntrospectionPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider token introspection resource path
setJwkPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setJWTOptions(JWTOptions) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setLogoutPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider logout path
setPubSecKeys(List<PubSecKeyOptions>) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setRedirectUri(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setRevocationPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the Oauth2 revocation resource path.
setScopeSeparator(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider scope separator
setSite(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Root URL for the provider without trailing slashes
setTenant(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Sets an optional tenant.
setTokenPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setTrustJWT(boolean) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
 
setUseBasicAuthorizationHeader(boolean) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Deprecated.
this value is not considered.
setUserAgent(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set a custom user agent to use when communicating to a provider
setUserInfoParameters(JsonObject) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set custom parameters to be sent during the userInfo resource request
setUserInfoPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider userInfo resource path
setValidateIssuer(boolean) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
ShopifyAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Shopify.
SoundcloudAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for SoundCloud.
statusCode() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Response
Deprecated.
the returned status code from the HTTP layer.
StripeAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Stripe.

T

toJson() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
toJson() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
toJson(OAuth2Options, JsonObject) - Static method in class io.vertx.ext.auth.oauth2.OAuth2OptionsConverter
 
toJson(OAuth2Options, Map<String, Object>) - Static method in class io.vertx.ext.auth.oauth2.OAuth2OptionsConverter
 
tokenType() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
 
toString() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
toString() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
TwitterAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Twitter.

U

userInfo(Handler<AsyncResult<JsonObject>>) - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Load the user info as per OIDC spec.
userInfo() - Method in interface io.vertx.ext.auth.oauth2.AccessToken
Deprecated.
Load the user info as per OIDC spec.
userInfo(User, Handler<AsyncResult<JsonObject>>) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Retrieve profile information and other attributes for a logged-in end-user.
userInfo(User) - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Retrieve profile information and other attributes for a logged-in end-user.

V

validate() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
valueOf(String) - Static method in enum io.vertx.ext.auth.oauth2.OAuth2FlowType
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.ext.auth.oauth2.OAuth2FlowType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I J K L M N O P R S T U V 
Skip navigation links

Copyright © 2020 Eclipse. All rights reserved.