Package com.broadleafcommerce.auth.user.web.autoconfigure

Class ClientIdentityProviderProperties.ClientProperties.Provider

java.lang.Object

com.broadleafcommerce.auth.user.web.autoconfigure.ClientIdentityProviderProperties.ClientProperties.Provider

Enclosing class:

ClientIdentityProviderProperties.ClientProperties

public static class ClientIdentityProviderProperties.ClientProperties.Provider
extends Object

Constructor Summary

Constructors

Constructor	Description
Provider()

Method Summary

Modifier and Type	Method	Description
Boolean	getAutoRegister()	Enable registering new users automatically after successful authentication.
ClientIdentityProviderProperties.ClientProperties.AutoRegisteredAdminUserProperties	getAutoRegisteredAdminUser()	If getAutoRegister() is enabled and the users being created are admin users, this configures details around those created admin users.
String	getIcon()	Path to an asset to show with the provider's name on the frontend.
void	setAutoRegister(Boolean autoRegister)	Enable registering new users automatically after successful authentication.
void	setAutoRegisteredAdminUser(ClientIdentityProviderProperties.ClientProperties.AutoRegisteredAdminUserProperties autoRegisteredAdminUser)	If getAutoRegister() is enabled and the users being created are admin users, this configures details around those created admin users.
void	setIcon(String icon)	Path to an asset to show with the provider's name on the frontend.

Methods inherited from class java.lang.Object

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

Constructor Details

Provider

public Provider()

Method Details

getAutoRegister

@Nullable
public Boolean getAutoRegister()

Enable registering new users automatically after successful authentication. Interpreted as false by default. This overrides ClientIdentityProviderProperties.ClientProperties.autoRegister if set.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

getAutoRegisteredAdminUser

public ClientIdentityProviderProperties.ClientProperties.AutoRegisteredAdminUserProperties getAutoRegisteredAdminUser()

If getAutoRegister() is enabled and the users being created are admin users, this configures details around those created admin users.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

getIcon

public String getIcon()

Path to an asset to show with the provider's name on the frontend.

setAutoRegister

public void setAutoRegister(@Nullable
 Boolean autoRegister)

Enable registering new users automatically after successful authentication. Interpreted as false by default. This overrides ClientIdentityProviderProperties.ClientProperties.autoRegister if set.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

setAutoRegisteredAdminUser

public void setAutoRegisteredAdminUser(ClientIdentityProviderProperties.ClientProperties.AutoRegisteredAdminUserProperties autoRegisteredAdminUser)

If getAutoRegister() is enabled and the users being created are admin users, this configures details around those created admin users.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

setIcon

public void setIcon(String icon)

Path to an asset to show with the provider's name on the frontend.