Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeycloakAuth

Simplified factory to create an for Keycloak.

Hierarchy

Index

Methods

Methods

Static create

  • Create a OAuth2Auth provider for Keycloak

    Parameters

    • vertx: Vertx
    • config: {}
      • [key: string]: any

    Returns OAuth2Auth

  • Create a OAuth2Auth provider for Keycloak

    Parameters

    Returns OAuth2Auth

  • Create a OAuth2Auth provider for Keycloak

    Parameters

    • vertx: Vertx
    • config: {}
      • [key: string]: any
    • httpClientOptions: HttpClientOptions

    Returns OAuth2Auth

  • Create a OAuth2Auth provider for Keycloak

    Parameters

    • vertx: Vertx
    • flow: OAuth2FlowType
    • config: {}
      • [key: string]: any
    • httpClientOptions: HttpClientOptions

    Returns OAuth2Auth

Static discover

  • 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.

    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.

    Parameters

    Returns PromiseLike<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.

    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.

    Parameters

    Returns void

Generated using TypeDoc