## Uses of Class
io.vertx.reactivex.ext.auth.User

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

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

    Fields in io.vertx.reactivex.ext.auth with type parameters of type User
    Modifier and Type | Field | Description
    --- | --- | ---
    `static io.vertx.lang.rx.TypeArg<User>` | User.`__TYPE_ARG` |

    Methods in io.vertx.reactivex.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.
    `static User` | User.`newInstance​(User arg)` |

    Methods in io.vertx.reactivex.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.reactivex.ext.auth.abac

    Methods in io.vertx.reactivex.ext.auth.abac with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | PolicyBasedAuthorizationProvider.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `boolean` | Attribute.`match​(User user)` | Verifies whether the attribute matches the specified user.
    `Completable` | PolicyBasedAuthorizationProvider.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

    Method parameters in io.vertx.reactivex.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.reactivex.ext.auth.audit

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

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

    Methods in io.vertx.reactivex.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.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate​(Credentials credentials)` | Authenticate a user.

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

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

    Methods in io.vertx.reactivex.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.
    `boolean` | AndAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `boolean` | NotAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `boolean` | OrAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `boolean` | PermissionBasedAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `boolean` | RoleBasedAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `boolean` | WildcardPermissionBasedAuthorization.`match​(User user)` | this methods verifies whether or not the authorization match the specified user.
    `Completable` | AuthorizationProvider.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

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

    Methods in io.vertx.reactivex.ext.auth.jwt.authorization with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | JWTAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Future<Void>` | MicroProfileAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | JWTAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | MicroProfileAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

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

    Methods in io.vertx.reactivex.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).
    `Single<User>` | OAuth2Auth.`rxRefresh​(User user)` | Refresh the current User (access token).

    Methods in io.vertx.reactivex.ext.auth.oauth2 with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `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).
    `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.
    `Single<User>` | OAuth2Auth.`rxRefresh​(User user)` | Refresh the current User (access token).
    `Completable` | OAuth2Auth.`rxRevoke​(User user)` | Revoke an obtained access token.
    `Completable` | OAuth2Auth.`rxRevoke​(User user, String tokenType)` | Revoke an obtained access or refresh token.
    `Single<JsonObject>` | OAuth2Auth.`rxUserInfo​(User user)` | Retrieve profile information and other attributes for a logged-in end-user.
    `Future<JsonObject>` | OAuth2Auth.`userInfo​(User user)` | Retrieve profile information and other attributes for a logged-in end-user.

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

    Methods in io.vertx.reactivex.ext.auth.oauth2.authorization with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | KeycloakAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Future<Void>` | ScopeAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | KeycloakAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | ScopeAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

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

    Methods in io.vertx.reactivex.ext.auth.properties with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | PropertyFileAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | PropertyFileAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

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

    Methods in io.vertx.reactivex.ext.auth.sqlclient with parameters of type User
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<Void>` | SqlAuthorization.`getAuthorizations​(User user)` | Updates the user with the set of authorizations.
    `Completable` | SqlAuthorization.`rxGetAuthorizations​(User user)` | Updates the user with the set of authorizations.

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

    Methods in io.vertx.reactivex.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 .

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

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

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

    Methods in io.vertx.reactivex.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.reactivex.ext.web.handler

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

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

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