Keycloak Core 24.0.0 · org.keycloak.representations.idm.IdentityProviderRepresentation

Field Summary

Modifier and Type	Field and Description
protected boolean	addReadTokenRoleOnCreate
protected String	alias
protected boolean	authenticateByDefault
protected Map<String, String>	config
protected String	displayName
protected boolean	enabled
protected String	firstBrokerLoginFlowAlias
protected String	internalId
protected boolean	linkOnly
protected String	postBrokerLoginFlowAlias
protected String	providerId
protected boolean	storeToken
protected boolean	trustEmail
protected String	updateProfileFirstLoginMode Mode of profile update after first login when user is created over this identity provider.
public static final String	UPFLM_MISSING
public static final String	UPFLM_OFF
public static final String	UPFLM_ON

Constructor Summary

Access	Constructor and Description
public	IdentityProviderRepresentation()

Method Summary

Modifier and Type	Method and Description
public String	getAlias()
public Map<String, String>	getConfig()
public String	getDisplayName()
public String	getFirstBrokerLoginFlowAlias()
public String	getInternalId()
public String	getPostBrokerLoginFlowAlias()
public String	getProviderId()
public String	getUpdateProfileFirstLoginMode() Deprecated deprecated and replaced by configuration on IdpReviewProfileAuthenticator
public boolean	isAddReadTokenRoleOnCreate()
public boolean	isAuthenticateByDefault() Deprecated Replaced by configuration option in identity provider authenticator
public boolean	isEnabled()
public boolean	isLinkOnly()
public boolean	isStoreToken()
public boolean	isTrustEmail()
public void	setAddReadTokenRoleOnCreate(boolean addReadTokenRoleOnCreate)
public void	setAlias(String alias)
public void	setAuthenticateByDefault(boolean authenticateByDefault) Deprecated
public void	setConfig(Map<String, String> config)
public void	setDisplayName(String displayName)
public void	setEnabled(boolean enabled)
public void	setFirstBrokerLoginFlowAlias(String firstBrokerLoginFlowAlias)
public void	setInternalId(String internalId)
public void	setLinkOnly(boolean linkOnly)
public void	setPostBrokerLoginFlowAlias(String postBrokerLoginFlowAlias)
public void	setProviderId(String providerId)
public void	setStoreToken(boolean storeToken)
public void	setTrustEmail(boolean trustEmail)
public void	setUpdateProfileFirstLogin(boolean updateProfileFirstLogin) Deprecated `setUpdateProfileFirstLoginMode(String)` Deprecated because replaced by `updateProfileFirstLoginMode`.
public void	setUpdateProfileFirstLoginMode(String updateProfileFirstLoginMode) Deprecated deprecated and replaced by configuration on IdpReviewProfileAuthenticator

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

addReadTokenRoleOnCreate	back to summary
protected boolean addReadTokenRoleOnCreate

alias	back to summary
protected String alias

authenticateByDefault	back to summary
protected boolean authenticateByDefault

config	back to summary
protected Map<String, String> config

displayName	back to summary
protected String displayName

enabled	back to summary
protected boolean enabled

firstBrokerLoginFlowAlias	back to summary
protected String firstBrokerLoginFlowAlias

internalId	back to summary
protected String internalId

linkOnly	back to summary
protected boolean linkOnly

postBrokerLoginFlowAlias	back to summary
protected String postBrokerLoginFlowAlias

providerId	back to summary
protected String providerId

storeToken	back to summary
protected boolean storeToken

trustEmail	back to summary
protected boolean trustEmail

updateProfileFirstLoginMode back to summary

updateProfileFirstLoginMode	back to summary
protected String updateProfileFirstLoginMode Deprecated Mode of profile update after first login when user is created over this identity provider. Possible values: `on` - update profile page is presented for all users `missing` - update profile page is presented for users with missing some of mandatory user profile fields `off` - update profile page is newer shown after first login Annotations @Deprecated See Also `UPFLM_ON`, `UPFLM_MISSING`, `UPFLM_OFF`

protected String updateProfileFirstLoginMode

Deprecated

Mode of profile update after first login when user is created over this identity provider. Possible values:

on - update profile page is presented for all users
missing - update profile page is presented for users with missing some of mandatory user profile fields
off - update profile page is newer shown after first login

Annotations

@Deprecated

See Also: UPFLM_ON, UPFLM_MISSING, UPFLM_OFF

UPFLM_MISSING	back to summary
public static final String UPFLM_MISSING

UPFLM_OFF	back to summary
public static final String UPFLM_OFF

UPFLM_ON	back to summary
public static final String UPFLM_ON

Constructor Detail

IdentityProviderRepresentation	back to summary
public IdentityProviderRepresentation()

Method Detail

getAlias	back to summary
public String getAlias()

getConfig	back to summary
public Map<String, String> getConfig()

getDisplayName	back to summary
public String getDisplayName()

getFirstBrokerLoginFlowAlias	back to summary
public String getFirstBrokerLoginFlowAlias()

getInternalId	back to summary
public String getInternalId()

getPostBrokerLoginFlowAlias	back to summary
public String getPostBrokerLoginFlowAlias()

getProviderId	back to summary
public String getProviderId()

getUpdateProfileFirstLoginMode	back to summary
public String getUpdateProfileFirstLoginMode() Deprecated deprecated and replaced by configuration on IdpReviewProfileAuthenticator Annotations @Deprecated

isAddReadTokenRoleOnCreate	back to summary
public boolean isAddReadTokenRoleOnCreate()

isAuthenticateByDefault	back to summary
public boolean isAuthenticateByDefault() Deprecated Replaced by configuration option in identity provider authenticator Annotations @Deprecated

isEnabled	back to summary
public boolean isEnabled()

isLinkOnly	back to summary
public boolean isLinkOnly()

isStoreToken	back to summary
public boolean isStoreToken()

isTrustEmail	back to summary
public boolean isTrustEmail()

setAddReadTokenRoleOnCreate	back to summary
public void setAddReadTokenRoleOnCreate(boolean addReadTokenRoleOnCreate)

setAlias	back to summary
public void setAlias(String alias)

setAuthenticateByDefault	back to summary
public void setAuthenticateByDefault(boolean authenticateByDefault) Deprecated Annotations @Deprecated

setConfig	back to summary
public void setConfig(Map<String, String> config)

setDisplayName	back to summary
public void setDisplayName(String displayName)

setEnabled	back to summary
public void setEnabled(boolean enabled)

setFirstBrokerLoginFlowAlias	back to summary
public void setFirstBrokerLoginFlowAlias(String firstBrokerLoginFlowAlias)

setInternalId	back to summary
public void setInternalId(String internalId)

setLinkOnly	back to summary
public void setLinkOnly(boolean linkOnly)

setPostBrokerLoginFlowAlias	back to summary
public void setPostBrokerLoginFlowAlias(String postBrokerLoginFlowAlias)

setProviderId	back to summary
public void setProviderId(String providerId)

setStoreToken	back to summary
public void setStoreToken(boolean storeToken)

setTrustEmail	back to summary
public void setTrustEmail(boolean trustEmail)

setUpdateProfileFirstLogin back to summary

setUpdateProfileFirstLogin	back to summary
public void setUpdateProfileFirstLogin(boolean updateProfileFirstLogin) Deprecated `setUpdateProfileFirstLoginMode(String)` Deprecated because replaced by `updateProfileFirstLoginMode`. Kept here to allow import of old realms. Annotations @Deprecated

public void setUpdateProfileFirstLogin(boolean updateProfileFirstLogin)

Deprecated

setUpdateProfileFirstLoginMode(String)

Deprecated because replaced by updateProfileFirstLoginMode. Kept here to allow import of old realms.

Annotations

@Deprecated

setUpdateProfileFirstLoginMode	back to summary
public void setUpdateProfileFirstLoginMode(String updateProfileFirstLoginMode) Deprecated deprecated and replaced by configuration on IdpReviewProfileAuthenticator Annotations @Deprecated

public Class IdentityProviderRepresentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail