A B C D E F G H I J K L M O P R S T U V 
All Classes All Packages

A

AAD_OBO - io.vertx.ext.auth.oauth2.OAuth2FlowType
Extension OAuth2 flows to perform JSON Web Token Bearer Token authentication "On-Behalf-Of an existing user.
addJwk(JsonObject) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Adds a local JWKs
addPubSecKey(PubSecKeyOptions) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
addScope(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Add a scope
addScope(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
addSupportedGrantType(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
AmazonCognitoAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Amazon Cognito.
AppleIdAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Apple.
AUTH_CODE - io.vertx.ext.auth.oauth2.OAuth2FlowType
The authorization code is obtained by using an authorization server as an intermediary between the client and resource owner.
AUTH_JWT - io.vertx.ext.auth.oauth2.OAuth2FlowType
RFC7523: JSON Web Token Bearer Token as a means for requesting an OAuth 2.0 access token as well as for client authentication.
Auth0Auth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Okta Auth0.
authorizeURL(OAuth2AuthorizationURL) - 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.
AzureADAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Azure AD.

B

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
 
claimKey() - Method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Returns the configured claim key.
CLIENT - io.vertx.ext.auth.oauth2.OAuth2FlowType
The client credentials (or other forms of client authentication) can be used as an authorization grant when the authorization scope is limited to the protected resources under the control of the client, or to protected resources previously arranged with the authorization server.
close() - Method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Releases any resources or timers used by this instance.
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() - Static method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Factory method to create a Authorization provider for Oauth 2.0 scopes using the default separator " ".
create(Vertx) - Static method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Create a OAuth2 auth provider.
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) - 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.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.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, OAuth2FlowType, JsonObject, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.KeycloakAuth
Create a OAuth2Auth provider for Keycloak
create(Vertx, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.OAuth2Auth
Create a OAuth2 auth provider
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) - 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) - 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.GiteeAuth
Create a OAuth2Auth provider for Gitee
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) - Static method in interface io.vertx.ext.auth.oauth2.providers.GitLabAuth
Create a OAuth2Auth provider for GitLab.com.
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) - Static method in interface io.vertx.ext.auth.oauth2.providers.HerokuAuth
Create a OAuth2Auth provider for Heroku
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) - 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) - 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) - 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) - 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.BoxAuth
Create a OAuth2Auth provider for App.net
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, HttpClientOptions) - 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.FoursquareAuth
Create a OAuth2Auth provider for Foursquare
create(Vertx, String, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.GiteeAuth
Create a OAuth2Auth provider for Gitee
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, HttpClientOptions) - 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.HerokuAuth
Create a OAuth2Auth provider for Heroku
create(Vertx, String, String, HttpClientOptions) - 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.LinkedInAuth
Create a OAuth2Auth provider for LinkedIn
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, HttpClientOptions) - 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.SalesforceAuth
Create a OAuth2Auth provider for Salesforce
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, HttpClientOptions) - 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.TwitterAuth
Create a OAuth2Auth provider for Twitter
create(Vertx, String, String, PubSecKeyOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.AppleIdAuth
Create a OAuth2Auth provider for Apple
create(Vertx, String, String, PubSecKeyOptions, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.AppleIdAuth
Create a OAuth2Auth provider for Apple
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) - Static method in interface io.vertx.ext.auth.oauth2.providers.CloudFoundryAuth
Create a OAuth2Auth provider for CloudFoundry UAA
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) - 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.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.CloudFoundryAuth
Create a OAuth2Auth provider for CloudFoundry UAA
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, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.ShopifyAuth
Create a OAuth2Auth provider for Shopify
create(Vertx, String, String, String, String) - Static method in interface io.vertx.ext.auth.oauth2.providers.Auth0Auth
Create a OAuth2Auth provider for Okta Auth0
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.Auth0Auth
Create a OAuth2Auth provider for Okta Auth0
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, 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, String, HttpClientOptions) - Static method in interface io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth
Create a OAuth2Auth provider for Amazon Cognito
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(String, String) - Static method in interface io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization
Factory method to create a Authorization provider for OpenID Connect scopes.

D

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) - 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.GoogleAuth
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) - 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.OpenIDConnectAuth
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.
discover(Vertx, PubSecKeyOptions, OAuth2Options) - Static method in interface io.vertx.ext.auth.oauth2.providers.AppleIdAuth
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

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) - 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, JsonObject) - 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.
FoursquareAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Foursquare.

G

getAdditionalParameters() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Get the additional parameters
getAssertion() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getAuthorizationPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Get the Oauth2 authorization resource path. e.g.: /oauth/authorize
getClientAssertion() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getClientAssertionType() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
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
getCode() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getCodeChallenge() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
PKCE code challenge
getCodeChallengeMethod() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
PKCE code challenge method
getCodeVerifier() - 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.Oauth2Credentials
 
getFlow(String) - Static method in enum io.vertx.ext.auth.oauth2.OAuth2FlowType
 
getGrantType() - Method in enum io.vertx.ext.auth.oauth2.OAuth2FlowType
 
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
getJwkMaxAgeInSeconds() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getJwkPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getJwks() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getJwt() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getJWTOptions() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
getLoginHint() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Hint on login name for IdP UI
getLogoutPath() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider logout path
getPassword() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
getPrompt() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Hint on kind of IdP prompt
getPubSecKeys() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider PubSec key options
getRedirectUri() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Get the redirect URI
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. e.g.: /oauth/revoke
getScopes() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Get the scopes
getScopes() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
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
 
getState() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Get the state
getSupportedGrantTypes() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
The provider supported grant types
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. e.g.: /oauth/token
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
getUsername() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
GiteeAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Gitee.
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

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.
IMPLICIT - io.vertx.ext.auth.oauth2.OAuth2FlowType
The implicit grant is a simplified authorization code flow optimized for clients implemented in a browser using a scripting language such as JavaScript.
InstagramAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Instagram.
io.vertx.auth.oauth2 - module io.vertx.auth.oauth2
 
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
 
isUseBasicAuthorization() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
isValidateIssuer() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 

J

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.

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.

M

MailchimpAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for Mailchimp.
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.

O

OAuth2Auth - Interface in io.vertx.ext.auth.oauth2
Factory interface for creating OAuth2 based AuthenticationProvider instances.
OAuth2AuthorizationURL - Class in io.vertx.ext.auth.oauth2
TypeSafe DataObject for passing needed parameters for OAuth2Auth.authorizeURL(OAuth2AuthorizationURL)
OAuth2AuthorizationURL() - Constructor for class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Default constructor
OAuth2AuthorizationURL(JsonObject) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Constructor to create an options from JSON
OAuth2AuthorizationURL(OAuth2AuthorizationURL) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Constructor to create an options from an existing options
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
 
Oauth2CredentialsConverter - Class in io.vertx.ext.auth.oauth2
Converter and mapper for Oauth2Credentials.
Oauth2CredentialsConverter() - Constructor for class io.vertx.ext.auth.oauth2.Oauth2CredentialsConverter
 
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(JsonObject) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2Options
Constructor to create an options from JSON
OAuth2Options(OAuth2Options) - Constructor for class io.vertx.ext.auth.oauth2.OAuth2Options
Copy constructor
OAuth2OptionsConverter - Class in io.vertx.ext.auth.oauth2
Converter and mapper for OAuth2Options.
OAuth2OptionsConverter() - Constructor for class io.vertx.ext.auth.oauth2.OAuth2OptionsConverter
 
OpenIDConnectAuth - Interface in io.vertx.ext.auth.oauth2.providers
Simplified factory to create an OAuth2Auth for OpenID Connect.

P

PASSWORD - io.vertx.ext.auth.oauth2.OAuth2FlowType
The resource owner password credentials (i.e., username and password) can be used directly as an authorization grant to obtain an access token.
putAdditionalParameter(String, String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Add an additional parameter

R

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(User) - 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.

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.
setAdditionalParameters(Map<String, String>) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Set the additional parameters
setAssertion(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setAuthorizationPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setClientAssertion(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setClientAssertionType(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
setCode(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setCodeChallenge(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
PKCE code challenge
setCodeChallengeMethod(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
PKCE code challenge method
setCodeVerifier(String) - 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.Oauth2Credentials
 
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
setJwkMaxAgeInSeconds(long) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
-1 means no rotation for JWKs
setJwkPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setJwks(List<JsonObject>) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Sets the initial local JWKs
setJwt(JsonObject) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setJWTOptions(JWTOptions) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setLoginHint(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Hint on login name for IdP UI
setLogoutPath(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
Set the provider logout path
setPassword(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
setPrompt(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Hint on kind of IdP prompt
setPubSecKeys(List<PubSecKeyOptions>) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
setRedirectUri(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Set the redirect URI
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. e.g.: /oauth/revoke
setScopes(List<String>) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Set the scopes
setScopes(List<String>) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
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
setState(String) - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
Set the state
setSupportedGrantTypes(List<String>) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
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
 
setUseBasicAuthorization(boolean) - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
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
setUsername(String) - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
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.
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.OAuth2AuthorizationURL
 
toJson() - Method in class io.vertx.ext.auth.oauth2.Oauth2Credentials
 
toJson() - Method in class io.vertx.ext.auth.oauth2.OAuth2Options
 
toString() - Method in class io.vertx.ext.auth.oauth2.OAuth2AuthorizationURL
 
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(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 O P R S T U V 
All Classes All Packages