io.vertx.ext.auth

## Interface AuthProvider

- All Known Subinterfaces:
    HtdigestAuth, JDBCAuth, JWTAuth, MongoAuth, OAuth2Auth, ShiroAuth

      public interface AuthProvider

  User-facing interface for authenticating users.
  Author:
    Tim Fox

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `authenticate(JsonObject authInfo, Handler<AsyncResult<User>> resultHandler)` Authenticate a user.

- - ### Method Detail

    - #### authenticate

          void authenticate(JsonObject authInfo,
                            Handler<AsyncResult<User>> resultHandler)

      Authenticate a user.

      The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:

             {
               "username": "tim",
               "password": "mypassword"
             }

      For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

      If the user is successfully authenticated a `User` object is passed to the handler in an `AsyncResult`. The user object can then be used for authorisation.

      Parameters:
        `authInfo` - The auth information
        `resultHandler` - The result handler

Copyright © 2017. All rights reserved.