## Uses of Interface
io.vertx.ext.auth.oauth2.OAuth2Auth

- Packages that use OAuth2Auth
  Package | Description
  --- | ---
  io.vertx.ext.auth.oauth2 |
  io.vertx.ext.auth.oauth2.providers |
  io.vertx.ext.web.client |
  io.vertx.ext.web.handler |
  io.vertx.reactivex.ext.auth.oauth2 |
  io.vertx.rxjava.ext.auth.oauth2 |
  io.vertx.rxjava3.ext.auth.oauth2 |

- - ### Uses of OAuth2Auth in io.vertx.ext.auth.oauth2

    Methods in io.vertx.ext.auth.oauth2 that return OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2Auth` | OAuth2Auth.`create(Vertx vertx)` Create a OAuth2 auth provider.
    `static OAuth2Auth` | OAuth2Auth.`create(Vertx vertx, OAuth2Options config)` Create a OAuth2 auth provider
    `default OAuth2Auth` | OAuth2Auth.`jWKSet(Handler<AsyncResult<Void>> handler)` Retrieve the public server JSON Web Key (JWK) required to verify the authenticity of issued ID and access tokens.
    `OAuth2Auth` | OAuth2Auth.`missingKeyHandler(Handler<String> handler)` Handled to be called when a key (mentioned on a JWT) is missing from the current config.
    `default OAuth2Auth` | OAuth2Auth.`refresh(User user, Handler<AsyncResult<User>> handler)` Refresh the current User (access token).
    `default OAuth2Auth` | OAuth2Auth.`revoke(User user, Handler<AsyncResult<Void>> handler)` Revoke an obtained access token.
    `default OAuth2Auth` | OAuth2Auth.`revoke(User user, String tokenType, Handler<AsyncResult<Void>> handler)` Revoke an obtained access or refresh token.
    `default OAuth2Auth` | OAuth2Auth.`userInfo(User user, Handler<AsyncResult<JsonObject>> handler)` Retrieve profile information and other attributes for a logged-in end-user.

  - ### Uses of OAuth2Auth in io.vertx.ext.auth.oauth2.providers

    Methods in io.vertx.ext.auth.oauth2.providers that return OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2Auth` | GoogleAuth.`create(Vertx vertx, JsonObject serviceAccountJson)` Create a OAuth2Auth provider for Google Service Account (Server to Server)
    `static OAuth2Auth` | KeycloakAuth.`create(Vertx vertx, JsonObject config)` Create a OAuth2Auth provider for Keycloak
    `static OAuth2Auth` | GoogleAuth.`create(Vertx vertx, JsonObject serviceAccountJson, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Google Service Account (Server to Server)
    `static OAuth2Auth` | KeycloakAuth.`create(Vertx vertx, JsonObject config, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Keycloak
    `static OAuth2Auth` | KeycloakAuth.`create(Vertx vertx, OAuth2FlowType flow, JsonObject config)` Create a OAuth2Auth provider for Keycloak
    `static OAuth2Auth` | KeycloakAuth.`create(Vertx vertx, OAuth2FlowType flow, JsonObject config, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Keycloak
    `static OAuth2Auth` | InstagramAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Instagram
    `static OAuth2Auth` | DropboxAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Dropbox
    `static OAuth2Auth` | LinkedInAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for LinkedIn
    `static OAuth2Auth` | SalesforceAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Salesforce
    `static OAuth2Auth` | BoxAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for App.net
    `static OAuth2Auth` | GoogleAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Google
    `static OAuth2Auth` | GitLabAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for GitLab.com.
    `static OAuth2Auth` | LiveAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for live.com
    `static OAuth2Auth` | GiteeAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Gitee
    `static OAuth2Auth` | GithubAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Github
    `static OAuth2Auth` | TwitterAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Twitter
    `static OAuth2Auth` | StripeAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Stripe
    `static OAuth2Auth` | SoundcloudAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for SoundCloud
    `static OAuth2Auth` | FoursquareAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Foursquare
    `static OAuth2Auth` | MailchimpAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Mailchimp
    `static OAuth2Auth` | HerokuAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Heroku
    `static OAuth2Auth` | FacebookAuth.`create(Vertx vertx, String clientId, String clientSecret)` Create a OAuth2Auth provider for Facebook
    `static OAuth2Auth` | InstagramAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Instagram
    `static OAuth2Auth` | DropboxAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Dropbox
    `static OAuth2Auth` | LinkedInAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for LinkedIn
    `static OAuth2Auth` | SalesforceAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Salesforce
    `static OAuth2Auth` | BoxAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for App.net
    `static OAuth2Auth` | GoogleAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Google
    `static OAuth2Auth` | LiveAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for live.com
    `static OAuth2Auth` | GiteeAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Gitee
    `static OAuth2Auth` | GithubAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Github
    `static OAuth2Auth` | TwitterAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Twitter
    `static OAuth2Auth` | StripeAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Stripe
    `static OAuth2Auth` | SoundcloudAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for SoundCloud
    `static OAuth2Auth` | FoursquareAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Foursquare
    `static OAuth2Auth` | MailchimpAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Mailchimp
    `static OAuth2Auth` | HerokuAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Heroku
    `static OAuth2Auth` | FacebookAuth.`create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Facebook
    `static OAuth2Auth` | CloudFoundryAuth.`create(Vertx vertx, String clientId, String clientSecret, String uuaURL)` Create a OAuth2Auth provider for CloudFoundry UAA
    `static OAuth2Auth` | ShopifyAuth.`create(Vertx vertx, String clientId, String clientSecret, String shop)` Create a OAuth2Auth provider for Shopify
    `static OAuth2Auth` | GitLabAuth.`create(Vertx vertx, String site, String clientId, String clientSecret)` Create a OAuth2Auth provider for GitLab.
    `static OAuth2Auth` | AzureADAuth.`create(Vertx vertx, String clientId, String clientSecret, String guid)` Create a OAuth2Auth provider for Microsoft Azure Active Directory
    `static OAuth2Auth` | CloudFoundryAuth.`create(Vertx vertx, String clientId, String clientSecret, String uuaURL, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for CloudFoundry UAA
    `static OAuth2Auth` | ShopifyAuth.`create(Vertx vertx, String clientId, String clientSecret, String shop, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Shopify
    `static OAuth2Auth` | GitLabAuth.`create(Vertx vertx, String site, String clientId, String clientSecret, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for GitLab.
    `static OAuth2Auth` | AzureADAuth.`create(Vertx vertx, String clientId, String clientSecret, String guid, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Microsoft Azure Active Directory
    `static OAuth2Auth` | IBMCloudAuth.`create(Vertx vertx, String region, String clientId, String clientSecret, String guid)` Create a OAuth2Auth provider for IBM Cloud
    `static OAuth2Auth` | AmazonCognitoAuth.`create(Vertx vertx, String region, String clientId, String clientSecret, String guid)` Create a OAuth2Auth provider for Amazon Cognito
    `static OAuth2Auth` | IBMCloudAuth.`create(Vertx vertx, String region, String clientId, String clientSecret, String guid, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for IBM Cloud
    `static OAuth2Auth` | AmazonCognitoAuth.`create(Vertx vertx, String region, String clientId, String clientSecret, String userPoolId, HttpClientOptions httpClientOptions)` Create a OAuth2Auth provider for Amazon Cognito

    Methods in io.vertx.ext.auth.oauth2.providers that return types with arguments of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static Future<OAuth2Auth>` | SalesforceAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | IBMCloudAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | GoogleAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | AzureADAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | OpenIDConnectAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | KeycloakAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static Future<OAuth2Auth>` | AmazonCognitoAuth.`discover(Vertx vertx, OAuth2Options config)` Create a OAuth2Auth provider for OpenID Connect Discovery.

    Method parameters in io.vertx.ext.auth.oauth2.providers with type arguments of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static void` | SalesforceAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | IBMCloudAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | GoogleAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | AzureADAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | OpenIDConnectAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | KeycloakAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.
    `static void` | AmazonCognitoAuth.`discover(Vertx vertx, OAuth2Options config, Handler<AsyncResult<OAuth2Auth>> handler)` Create a OAuth2Auth provider for OpenID Connect Discovery.

  - ### Uses of OAuth2Auth in io.vertx.ext.web.client

    Methods in io.vertx.ext.web.client with parameters of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2WebClient` | OAuth2WebClient.`create(WebClient webClient, OAuth2Auth oAuth2Auth)` Create a session aware web client using the provided `webClient` instance.
    `static OAuth2WebClient` | OAuth2WebClient.`create(WebClient webClient, OAuth2Auth oAuth2Auth, OAuth2WebClientOptions options)` Create a session aware web client using the provided `webClient` instance.

  - ### Uses of OAuth2Auth in io.vertx.ext.web.handler

    Methods in io.vertx.ext.web.handler with parameters of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2AuthHandler` | OAuth2AuthHandler.`create(Vertx vertx, OAuth2Auth authProvider)` Create a OAuth2 auth handler without host pinning.
    `static OAuth2AuthHandler` | OAuth2AuthHandler.`create(Vertx vertx, OAuth2Auth authProvider, String callbackURL)` Create a OAuth2 auth handler with host pinning

  - ### Uses of OAuth2Auth in io.vertx.reactivex.ext.auth.oauth2

    Methods in io.vertx.reactivex.ext.auth.oauth2 that return OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `OAuth2Auth` | OAuth2Auth.`getDelegate()`

    Methods in io.vertx.reactivex.ext.auth.oauth2 with parameters of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2Auth` | OAuth2Auth.`newInstance(OAuth2Auth arg)`

    Constructors in io.vertx.reactivex.ext.auth.oauth2 with parameters of type OAuth2Auth
    Constructor and Description
    `OAuth2Auth(OAuth2Auth delegate)`

  - ### Uses of OAuth2Auth in io.vertx.rxjava.ext.auth.oauth2

    Methods in io.vertx.rxjava.ext.auth.oauth2 that return OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `OAuth2Auth` | OAuth2Auth.`getDelegate()`

    Methods in io.vertx.rxjava.ext.auth.oauth2 with parameters of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2Auth` | OAuth2Auth.`newInstance(OAuth2Auth arg)`

    Constructors in io.vertx.rxjava.ext.auth.oauth2 with parameters of type OAuth2Auth
    Constructor and Description
    `OAuth2Auth(OAuth2Auth delegate)`

  - ### Uses of OAuth2Auth in io.vertx.rxjava3.ext.auth.oauth2

    Methods in io.vertx.rxjava3.ext.auth.oauth2 that return OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `OAuth2Auth` | OAuth2Auth.`getDelegate()`

    Methods in io.vertx.rxjava3.ext.auth.oauth2 with parameters of type OAuth2Auth
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2Auth` | OAuth2Auth.`newInstance(OAuth2Auth arg)`

    Constructors in io.vertx.rxjava3.ext.auth.oauth2 with parameters of type OAuth2Auth
    Constructor and Description
    `OAuth2Auth(OAuth2Auth delegate)`

Copyright © 2024 Eclipse. All rights reserved.