## Uses of Interface
io.vertx.ext.auth.authentication.Credentials

- Packages that use Credentials
  Package | Description
  --- | ---
  io.vertx.ext.auth.authentication |
  io.vertx.ext.auth.htdigest |
  io.vertx.ext.auth.oauth2 |
  io.vertx.ext.auth.otp |
  io.vertx.ext.auth.webauthn |
  io.vertx.ext.web.client |
  io.vertx.reactivex.ext.auth.authentication |
  io.vertx.reactivex.ext.web.client |
  io.vertx.rxjava.ext.auth.authentication |
  io.vertx.rxjava.ext.web.client |
  io.vertx.rxjava3.ext.auth.authentication |
  io.vertx.rxjava3.ext.web.client |

- - ### Uses of Credentials in io.vertx.ext.auth.authentication

    Classes in io.vertx.ext.auth.authentication that implement Credentials
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TokenCredentials` Credentials used by any `AuthenticationProvider` that requires Tokens, such as OAuth2 or JWT to perform its authentication
    `class` | `UsernamePasswordCredentials` Credentials used by any `AuthenticationProvider` that requires tokens, for example JWT, Oauth2, OpenId Connect

    Methods in io.vertx.ext.auth.authentication that return Credentials
    Modifier and Type | Method and Description
    --- | ---
    `default Credentials` | Credentials.`applyHttpChallenge(String challenge)` Applies the HTTP Authorization challenge to this Credential instance.
    `default Credentials` | Credentials.`applyHttpChallenge(String challenge, HttpMethod method, String uri)` Applies the HTTP Authorization challenge to this Credential instance.
    `default Credentials` | Credentials.`applyHttpChallenge(String challenge, HttpMethod method, String uri, Integer nc, String cnonce)` Applies the HTTP Authorization challenge to this Credential instance.

    Methods in io.vertx.ext.auth.authentication with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `default Future<User>` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `default void` | AuthenticationProvider.`authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler)` Authenticate a user.

  - ### Uses of Credentials in io.vertx.ext.auth.htdigest

    Classes in io.vertx.ext.auth.htdigest that implement Credentials
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HtdigestCredentials` Credentials specific to the `HtdigestAuth` authentication provider

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

    Classes in io.vertx.ext.auth.oauth2 that implement Credentials
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Oauth2Credentials` Credentials specific to the `OAuth2Auth` provider

  - ### Uses of Credentials in io.vertx.ext.auth.otp

    Classes in io.vertx.ext.auth.otp that implement Credentials
    Modifier and Type | Class and Description
    --- | ---
    `class` | `OtpCredentials` Credentials for `HotpAuth` or `TotpAuth` authentication providers.

  - ### Uses of Credentials in io.vertx.ext.auth.webauthn

    Classes in io.vertx.ext.auth.webauthn that implement Credentials
    Modifier and Type | Class and Description
    --- | ---
    `class` | `WebAuthnCredentials`

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

    Methods in io.vertx.ext.web.client with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `HttpRequest<T>` | HttpRequest.`authentication(Credentials credentials)` Configure the request to perform HTTP Authentication.
    `OAuth2WebClient` | OAuth2WebClient.`withCredentials(Credentials credentials)` Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider

  - ### Uses of Credentials in io.vertx.reactivex.ext.auth.authentication

    Methods in io.vertx.reactivex.ext.auth.authentication with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `void` | AuthenticationProvider.`authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate(Credentials credentials)` Authenticate a user.

  - ### Uses of Credentials in io.vertx.reactivex.ext.web.client

    Methods in io.vertx.reactivex.ext.web.client with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `HttpRequest<T>` | HttpRequest.`authentication(Credentials credentials)` Configure the request to perform HTTP Authentication.
    `OAuth2WebClient` | OAuth2WebClient.`withCredentials(Credentials credentials)` Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider

  - ### Uses of Credentials in io.vertx.rxjava.ext.auth.authentication

    Methods in io.vertx.rxjava.ext.auth.authentication with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `void` | AuthenticationProvider.`authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate(Credentials credentials)` Authenticate a user.

  - ### Uses of Credentials in io.vertx.rxjava.ext.web.client

    Methods in io.vertx.rxjava.ext.web.client with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `HttpRequest<T>` | HttpRequest.`authentication(Credentials credentials)` Configure the request to perform HTTP Authentication.
    `OAuth2WebClient` | OAuth2WebClient.`withCredentials(Credentials credentials)` Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider

  - ### Uses of Credentials in io.vertx.rxjava3.ext.auth.authentication

    Methods in io.vertx.rxjava3.ext.auth.authentication with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `Single<User>` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate(Credentials credentials)` Authenticate a user.

  - ### Uses of Credentials in io.vertx.rxjava3.ext.web.client

    Methods in io.vertx.rxjava3.ext.web.client with parameters of type Credentials
    Modifier and Type | Method and Description
    --- | ---
    `HttpRequest<T>` | HttpRequest.`authentication(Credentials credentials)` Configure the request to perform HTTP Authentication.
    `OAuth2WebClient` | OAuth2WebClient.`withCredentials(Credentials credentials)` Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider

Copyright © 2024 Eclipse. All rights reserved.