User-facing interface for authenticating users.
| package |
Default |
|---|
__construct()
authenticate( $arg0, $arg1) : void
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 @see \io\vertx\jphp\ext\auth\User object is passed to the handler in an \io.vertx.core.AsyncResult. The user object can then be used for authorisation.
array
callable