Module one.jpro.platform.auth.core

Package one.jpro.platform.auth.core.oauth2.provider

Class MicrosoftAuthenticationProvider

java.lang.Object

one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider

one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider

one.jpro.platform.auth.core.oauth2.provider.MicrosoftAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider<Credentials>

public class MicrosoftAuthenticationProvider
extends OpenIDAuthenticationProvider

Simplified factory to create an OAuth2AuthenticationProvider for Microsoft.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMON_TENANT	The common tenant identifier for Microsoft OAuth2.
static final String	CONSUMERS_TENANT	The consumers tenant identifier for Microsoft OAuth2.
static final List<String>	DEFAULT_SCOPES
static final String	ORGANIZATIONS_TENANT	The organizations tenant identifier for Microsoft OAuth2.

Constructor Summary

Constructors

Constructor	Description
MicrosoftAuthenticationProvider(@Nullable javafx.stage.Stage stage, @NotNull String clientId, @NotNull String clientSecret, @NotNull String tenant)	Create an OAuth2AuthenticationProvider for Microsoft.
MicrosoftAuthenticationProvider(@Nullable javafx.stage.Stage stage, @NotNull OAuth2Options options)	Create an OAuth2AuthenticationProvider for Microsoft.

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<OpenIDAuthenticationProvider>	discover(javafx.stage.Stage stage, OAuth2Options options)	Create an OAuth2AuthenticationProvider for OpenID Connect Discovery.

Methods inherited from class one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider

authenticate, authorizeUrl, getCredentials

Methods inherited from class one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider

authenticate, authorizeUrl, discover, getOptions, introspect, logout, refresh, revoke, userInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMMON_TENANT

public static final String COMMON_TENANT

The common tenant identifier for Microsoft OAuth2.

See Also:

• Constant Field Values

CONSUMERS_TENANT

public static final String CONSUMERS_TENANT

The consumers tenant identifier for Microsoft OAuth2.

See Also:

• Constant Field Values

ORGANIZATIONS_TENANT

public static final String ORGANIZATIONS_TENANT

The organizations tenant identifier for Microsoft OAuth2.

See Also:

• Constant Field Values

DEFAULT_SCOPES

public static final List<String> DEFAULT_SCOPES

Constructor Details

MicrosoftAuthenticationProvider

public MicrosoftAuthenticationProvider(@Nullable
 @Nullable javafx.stage.Stage stage,
 @NotNull
 @NotNull OAuth2Options options)

Create an OAuth2AuthenticationProvider for Microsoft.

Parameters:

stage - the JavaFX application stage

options - the custom set of OAuth2 options which include configuration like client ID, client secret, scopes, and other OAuth2 parameters.

MicrosoftAuthenticationProvider

public MicrosoftAuthenticationProvider(@Nullable
 @Nullable javafx.stage.Stage stage,
 @NotNull
 @NotNull String clientId,
 @NotNull
 @NotNull String clientSecret,
 @NotNull
 @NotNull String tenant)

Create an OAuth2AuthenticationProvider for Microsoft.

Parameters:

stage - the JavaFX application stage

clientId - the client ID issued by Microsoft for your application.

clientSecret - the client secret issued by Microsoft for securing your application.

tenant - the GUID or tenant ID that represents your application's directory.

Method Details

discover

public static CompletableFuture<OpenIDAuthenticationProvider> discover(javafx.stage.Stage stage,
 OAuth2Options options)

Create an OAuth2AuthenticationProvider 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, then it will be used to do the lookup.

Parameters:

stage - the JavaFX application stage

options - custom OAuth2 options

Returns:

a future with the instantiated OAuth2AuthenticationProvider