API Documentation
Back to top  

KeycloakAuth

Simplified factory to create an for Keycloak.

package

Default

Methods

__construct

__construct()

Create a OAuth2Auth provider for Keycloak

create( $arg0,  $arg1,  $arg2 = null,  $arg3 = null) : \io\vertx\jphp\ext\auth\oauth2\OAuth2Auth
static

param $vertx [Vertx] param $config [array] the json config file exported from Keycloak admin console create($vertx, $config)

Create a OAuth2Auth provider for Keycloak

param $vertx [Vertx] param $flow [string] the oauth2 flow to use param $config [array] the json config file exported from Keycloak admin console create($vertx, $flow, $config)

Create a OAuth2Auth provider for Keycloak

param $vertx [Vertx] param $config [array] the json config file exported from Keycloak admin console param $httpClientOptions [HttpClientOptions | array] custom http client options create($vertx, $config, $httpClientOptions)

Create a OAuth2Auth provider for Keycloak

param $vertx [Vertx] param $flow [string] the oauth2 flow to use param $config [array] the json config file exported from Keycloak admin console param $httpClientOptions [HttpClientOptions | array] custom http client options create($vertx, $flow, $config, $httpClientOptions)

Arguments

$arg0

Vertx

$arg1

string | array

$arg2

array | HttpClientOptions

$arg3

array | HttpClientOptions

Response

\io\vertx\jphp\ext\auth\oauth2\OAuth2Auth

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

discover( $arg0,  $arg1,  $arg2) : void
static

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Arguments

$arg0

Vertx

$arg1

array | OAuth2ClientOptions

$arg2

callable