Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AzureADAuth

Simplified factory to create an for Azure AD.

Hierarchy

Index

Methods

Methods

Static create

  • create(vertx: Vertx, clientId: string, clientSecret: string, guid: string): OAuth2Auth
  • create(vertx: Vertx, clientId: string, clientSecret: string, guid: string, httpClientOptions: HttpClientOptions): OAuth2Auth

  • Create a OAuth2Auth provider for Microsoft Azure Active Directory

    Parameters

    • vertx: Vertx
    • clientId: string
    • clientSecret: string
    • guid: string

    Returns OAuth2Auth

  • Create a OAuth2Auth provider for Microsoft Azure Active Directory

    Parameters

    • vertx: Vertx
    • clientId: string
    • clientSecret: string
    • guid: string
    • 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.

    With this provider, if the given configuration is using the flow type then the extra parameters object will include requested_token_use = on_behalf_of as required by https://docs.microsoft.com/en-us/azure/active-directory.

    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.

    With this provider, if the given configuration is using the flow type then the extra parameters object will include requested_token_use = on_behalf_of as required by https://docs.microsoft.com/en-us/azure/active-directory.

    Parameters

    Returns void

Generated using TypeDoc