## Uses of Interface
io.vertx.ext.auth.User

- Packages that use User
  Package | Description
  --- | ---
  io.vertx.ext.auth |
  io.vertx.ext.auth.abac |
  io.vertx.ext.auth.audit |
  io.vertx.ext.auth.authentication |
  io.vertx.ext.auth.authorization |
  io.vertx.ext.auth.oauth2 |
  io.vertx.ext.stomp |
  io.vertx.ext.web |
  io.vertx.ext.web.client |
  io.vertx.ext.web.handler |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.reactivex.ext.auth |
  io.vertx.rxjava3.ext.auth |

- - ### Uses of User in io.vertx.ext.auth

    Methods in io.vertx.ext.auth that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `static User` | User.`create​(JsonObject principal)` | Factory for user instances that are free form.
    `static User` | User.`create​(JsonObject principal, JsonObject attributes)` | Factory for user instances that are free form.
    `static User` | User.`fromName​(String username)` | Factory for user instances that are single string.
    `static User` | User.`fromToken​(String token)` | Factory for user instances that are single string.
    `User` | User.`merge​(User other)` | Merge the principal and attributes of a second user into this object properties.

    Methods in io.vertx.ext.auth with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | User.`merge​(User other)` | Merge the principal and attributes of a second user into this object properties.

  - ### Uses of User in io.vertx.ext.auth.abac

    Methods in io.vertx.ext.auth.abac with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | Attribute.`match​(User user)` | Verifies whether the attribute matches the specified user.

    Method parameters in io.vertx.ext.auth.abac with type arguments of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Attribute` | Attribute.`create​(Function<User,​Boolean> function)` | A custom function to be used during matching.

  - ### Uses of User in io.vertx.ext.auth.audit

    Methods in io.vertx.ext.auth.audit with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `SecurityAudit` | SecurityAudit.`user​(User user)` |

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

    Methods in io.vertx.ext.auth.authentication that return types with arguments of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<User>` | AuthenticationProvider.`authenticate​(Credentials credentials)` | Authenticate a user.

  - ### Uses of User in io.vertx.ext.auth.authorization

    Methods in io.vertx.ext.auth.authorization that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | AuthorizationContext.`user()` | Get the authenticated user

    Methods in io.vertx.ext.auth.authorization with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `static AuthorizationContext` | AuthorizationContext.`create​(User user)` | Factory for Authorization Context
    `static AuthorizationContext` | AuthorizationContext.`create​(User user, MultiMap variables)` | Factory for Authorization Context
    `Future<Void>` | AuthorizationProvider.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `default boolean` | Authorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.

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

    Methods in io.vertx.ext.auth.oauth2 that return types with arguments of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<User>` | OAuth2Auth.`refresh​(User user)` | Refresh the current User (access token).

    Methods in io.vertx.ext.auth.oauth2 with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `default String` | OAuth2Auth.`endSessionURL​(User user)` | The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
    `String` | OAuth2Auth.`endSessionURL​(User user, JsonObject params)` | The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
    `Future<User>` | OAuth2Auth.`refresh​(User user)` | Refresh the current User (access token).
    `default Future<Void>` | OAuth2Auth.`revoke​(User user)` | Revoke an obtained access token.
    `Future<Void>` | OAuth2Auth.`revoke​(User user, String tokenType)` | Revoke an obtained access or refresh token.
    `Future<JsonObject>` | OAuth2Auth.`userInfo​(User user)` | Retrieve profile information and other attributes for a logged-in end-user.

  - ### Uses of User in io.vertx.ext.stomp

    Methods in io.vertx.ext.stomp that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | StompServerHandler.`getUserBySession​(String session)` | Provides for authorization matches on a destination level, this will return the User created by the `AuthenticationProvider`.

  - ### Uses of User in io.vertx.ext.web

    Methods in io.vertx.ext.web that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | UserContext.`get()` | Get the authenticated user (if any).
    `default User` | RoutingContext.`user()` | Get the authenticated user (if any).

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

    Methods in io.vertx.ext.web.client that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | OAuth2WebClient.`getUser()` | Get the authenticated user (if any) that is associated with this client.

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

    Methods in io.vertx.ext.web.handler with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | SessionHandler.`setUser​(RoutingContext context, User user)` | Set the user for the session

    Method parameters in io.vertx.ext.web.handler with type arguments of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `SimpleAuthenticationHandler` | SimpleAuthenticationHandler.`authenticate​(Function<RoutingContext,​Future<User>> authenticationFunction)` | This function will allow you to perform authentication the way you intended to.

  - ### Uses of User in io.vertx.ext.web.handler.sockjs

    Methods in io.vertx.ext.web.handler.sockjs that return User
    Modifier and Type | Method | Description
    --- | --- | ---
    `User` | SockJSSocket.`webUser()` |

  - ### Uses of User in io.vertx.reactivex.ext.auth

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

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

    Constructors in io.vertx.reactivex.ext.auth with parameters of type User
    Constructor | Description
    --- | ---
    `User​(User delegate)` |

  - ### Uses of User in io.vertx.rxjava3.ext.auth

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

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

    Constructors in io.vertx.rxjava3.ext.auth with parameters of type User
    Constructor | Description
    --- | ---
    `User​(User delegate)` |