Skip to main content

OpenIdConnectClientOptions

OpenIdConnectClient configuration for an application

Index

Properties

Properties

readonlyclientId

clientId: string

The client id associated with the application

readonlyopenIdProviderUrl

openIdProviderUrl: string | URL

The URL of the Open ID Connect provider. openIdProviderUrl should either point to the root of the Open ID Connect provider or directly at its .well-known/openid-configuration. It is used verbatim (the host is taken as given); see deriveOpenIdProviderConfigurationUrl.

To discover the provider from the current page's origin instead of hardcoding a host, use openIdProviderConfigurationUrl to compute this value — that helper roots discovery at an app origin (defaulting to window.location.origin) and strips a leading bim. from the host.

@example
if (openIdProviderUrl.endsWith('.well-known/openid-configuration')) {
  // `${openIdProviderUrl}` will be used to resolve the provider's configuration
} else {
  // `${openIdProviderUrl}/.well-known/openid-configuration` will be used to resolve the provider's configuration
}

readonlyredirectUri

redirectUri: string | URL

The URL that the Open ID Connect provider should redirect the browser back to after authentication.

Page Options