Package org.keycloak.models

Class IdentityProviderModel

java.lang.Object
org.keycloak.models.IdentityProviderModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
OAuth2IdentityProviderConfig, SAMLIdentityProviderConfig
public class IdentityProviderModel extends Object implements Serializable

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 Details

  • Constructor Details

    • IdentityProviderModel

      public IdentityProviderModel()

    • IdentityProviderModel

      public IdentityProviderModel(IdentityProviderModel model)

  • Method Details

    • getInternalId

      public String getInternalId()

    • setInternalId

      public void setInternalId(String internalId)

    • getAlias

      public String getAlias()

    • setAlias

      public void setAlias(String id)

    • getProviderId

      public String getProviderId()

    • setProviderId

      public void setProviderId(String providerId)

    • 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 public boolean isAuthenticateByDefault()
      Deprecated.

    • setAuthenticateByDefault

      @Deprecated public void setAuthenticateByDefault(boolean authenticateByDefault)
      Deprecated.

    • getFirstBrokerLoginFlowId

      public String getFirstBrokerLoginFlowId()

    • setFirstBrokerLoginFlowId

      public void setFirstBrokerLoginFlowId(String firstBrokerLoginFlowId)

    • getPostBrokerLoginFlowId

      public String getPostBrokerLoginFlowId()

    • setPostBrokerLoginFlowId

      public void setPostBrokerLoginFlowId(String postBrokerLoginFlowId)

    • getConfig

      public Map<String,String> getConfig()

    • setConfig

      public void setConfig(Map<String,String> config)

    • isAddReadTokenRoleOnCreate

      public boolean isAddReadTokenRoleOnCreate()

    • setAddReadTokenRoleOnCreate

      public void setAddReadTokenRoleOnCreate(boolean addReadTokenRoleOnCreate)

    • isTrustEmail

      public boolean isTrustEmail()

    • setTrustEmail

      public void setTrustEmail(boolean trustEmail)

    • getDisplayName

      public String getDisplayName()

    • setDisplayName

      public void setDisplayName(String displayName)

    • getDisplayIconClasses

      public String getDisplayIconClasses()

    • validate

      public void validate(RealmModel realm)

      Validates this configuration.

      Sub-classes can override this method in order to enforce provider specific validations.

      Parameters:
      realm - the realm

    • getSyncMode

      public IdentityProviderSyncMode getSyncMode()

    • setSyncMode

      public void setSyncMode(IdentityProviderSyncMode syncMode)

    • 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)

    • isTransientUsers

      public boolean isTransientUsers()
      Returns flag whether the users withing this IdP should be transient, ie. not stored in Keycloak database. Default value: false.
      Returns:

    • setTransientUsers

      public void setTransientUsers(boolean transientUsers)
      Configures the IdP to not store users in Keycloak database. Default value: false.

    • isFilteredByClaims

      public boolean isFilteredByClaims()

    • setFilteredByClaims

      public void setFilteredByClaims(boolean filteredByClaims)

    • getClaimFilterName

      public String getClaimFilterName()

    • setClaimFilterName

      public void setClaimFilterName(String claimFilterName)

    • getClaimFilterValue

      public String getClaimFilterValue()

    • setClaimFilterValue

      public void setClaimFilterValue(String claimFilterValue)

    • getMetadataDescriptorUrl

      public String getMetadataDescriptorUrl()

    • setMetadataDescriptorUrl

      public void setMetadataDescriptorUrl(String metadataDescriptorUrl)