Package org.keycloak.models
Class IdentityProviderModel
java.lang.Object
org.keycloak.models.IdentityProviderModel
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
OAuth2IdentityProviderConfig,SAMLIdentityProviderConfig
A model type representing the configuration for identity providers. It provides some common properties and also a config
for configuration options and properties specifics to a identity provider.
- Author:
- Pedro Igor
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAlias()booleanbooleanDeprecated.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidsetAddReadTokenRoleOnCreate(boolean addReadTokenRoleOnCreate) voidvoidsetAuthenticateByDefault(boolean authenticateByDefault) Deprecated.voidsetClaimFilterName(String claimFilterName) voidsetClaimFilterValue(String claimFilterValue) voidvoidsetDisplayName(String displayName) voidsetEnabled(boolean enabled) voidsetFilteredByClaims(boolean filteredByClaims) voidsetFirstBrokerLoginFlowId(String firstBrokerLoginFlowId) voidsetHideOnLogin(boolean hideOnLogin) voidsetInternalId(String internalId) voidsetLinkOnly(boolean linkOnly) voidsetLoginHint(boolean loginHint) voidsetPassMaxAge(boolean passMaxAge) voidsetPostBrokerLoginFlowId(String postBrokerLoginFlowId) voidsetProviderId(String providerId) voidsetStoreToken(boolean storeToken) voidsetSyncMode(IdentityProviderSyncMode syncMode) voidsetTrustEmail(boolean trustEmail) voidvalidate(RealmModel realm) Validates this configuration.
-
Field Details
-
ALLOWED_CLOCK_SKEW
- See Also:
-
LOGIN_HINT
- See Also:
-
PASS_MAX_AGE
- See Also:
-
SYNC_MODE
- See Also:
-
HIDE_ON_LOGIN
- See Also:
-
FILTERED_BY_CLAIMS
- See Also:
-
CLAIM_FILTER_NAME
- See Also:
-
CLAIM_FILTER_VALUE
- See Also:
-
addReadTokenRoleOnCreate
protected boolean addReadTokenRoleOnCreate -
linkOnly
protected boolean linkOnly
-
-
Constructor Details
-
IdentityProviderModel
public IdentityProviderModel() -
IdentityProviderModel
-
-
Method Details
-
getInternalId
-
setInternalId
-
getAlias
-
setAlias
-
getProviderId
-
setProviderId
-
isEnabled
public boolean isEnabled() -
setEnabled
public void setEnabled(boolean enabled) -
isStoreToken
public boolean isStoreToken() -
setStoreToken
public void setStoreToken(boolean storeToken) -
isLinkOnly
public boolean isLinkOnly() -
setLinkOnly
public void setLinkOnly(boolean linkOnly) -
isAuthenticateByDefault
Deprecated. -
setAuthenticateByDefault
Deprecated. -
getFirstBrokerLoginFlowId
-
setFirstBrokerLoginFlowId
-
getPostBrokerLoginFlowId
-
setPostBrokerLoginFlowId
-
getConfig
-
setConfig
-
isAddReadTokenRoleOnCreate
public boolean isAddReadTokenRoleOnCreate() -
setAddReadTokenRoleOnCreate
public void setAddReadTokenRoleOnCreate(boolean addReadTokenRoleOnCreate) -
isTrustEmail
public boolean isTrustEmail() -
setTrustEmail
public void setTrustEmail(boolean trustEmail) -
getDisplayName
-
setDisplayName
-
getDisplayIconClasses
-
validate
Validates this configuration.
Sub-classes can override this method in order to enforce provider specific validations.
- Parameters:
realm- the realm
-
getSyncMode
-
setSyncMode
-
isLoginHint
public boolean isLoginHint() -
setLoginHint
public void setLoginHint(boolean loginHint) -
isPassMaxAge
public boolean isPassMaxAge() -
setPassMaxAge
public void setPassMaxAge(boolean passMaxAge) -
isHideOnLogin
public boolean isHideOnLogin() -
setHideOnLogin
public void setHideOnLogin(boolean hideOnLogin) -
isFilteredByClaims
public boolean isFilteredByClaims() -
setFilteredByClaims
public void setFilteredByClaims(boolean filteredByClaims) -
getClaimFilterName
-
setClaimFilterName
-
getClaimFilterValue
-
setClaimFilterValue
-