Class CredentialModel

java.lang.Object
org.keycloak.credential.CredentialModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
OTPCredentialModel, PasswordCredentialModel, RecoveryAuthnCodesCredentialModel, WebAuthnCredentialModel

public class CredentialModel extends Object implements Serializable
Used just in cases when we want to "directly" update or retrieve the hash or salt of user credential (For example during export/import)
Author:
Marek Posolda
See Also:
  • Field Details

  • Constructor Details

    • CredentialModel

      public CredentialModel()
  • Method Details

    • shallowClone

      public CredentialModel shallowClone()
    • getId

      public String getId()
    • setId

      public void setId(String id)
    • getType

      public String getType()
    • setType

      public void setType(String type)
    • getUserLabel

      public String getUserLabel()
    • setUserLabel

      public void setUserLabel(String userLabel)
    • getCreatedDate

      public Long getCreatedDate()
    • setCreatedDate

      public void setCreatedDate(Long createdDate)
    • getSecretData

      public String getSecretData()
    • setSecretData

      public void setSecretData(String secretData)
    • getCredentialData

      public String getCredentialData()
    • setCredentialData

      public void setCredentialData(String credentialData)
    • comparingByStartDateDesc

      public static Comparator<CredentialModel> comparingByStartDateDesc()
    • getValue

      @Deprecated public String getValue()
      Deprecated.
      Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
    • setValue

      @Deprecated public void setValue(String value)
      Deprecated.
    • getDevice

      @Deprecated public String getDevice()
      Deprecated.
      Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
    • setDevice

      @Deprecated public void setDevice(String device)
      Deprecated.
    • getSalt

      @Deprecated public byte[] getSalt()
      Deprecated.
      Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
    • setSalt

      @Deprecated public void setSalt(byte[] salt)
      Deprecated.
    • getHashIterations

      @Deprecated public int getHashIterations()
      Deprecated.
      Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
    • setHashIterations

      @Deprecated public void setHashIterations(int iterations)
      Deprecated.
    • getCounter

      @Deprecated public int getCounter()
      Deprecated.
      Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
    • setCounter

      @Deprecated public void setCounter(int counter)
      Deprecated.
    • getAlgorithm

      @Deprecated public String getAlgorithm()
      Deprecated.
      Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
    • setAlgorithm

      @Deprecated public void setAlgorithm(String algorithm)
      Deprecated.
    • getDigits

      @Deprecated public int getDigits()
      Deprecated.
      Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
    • setDigits

      @Deprecated public void setDigits(int digits)
      Deprecated.
    • getPeriod

      @Deprecated public int getPeriod()
      Deprecated.
      Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
    • setPeriod

      @Deprecated public void setPeriod(int period)
      Deprecated.
    • getConfig

      @Deprecated public org.keycloak.common.util.MultivaluedHashMap<String,String> getConfig()
      Deprecated.
      Recommended to use getCredentialData() instead and use the subtype of CredentialData specific to your credential
    • setConfig

      @Deprecated public void setConfig(org.keycloak.common.util.MultivaluedHashMap<String,String> config)
      Deprecated.
      Recommended to use setCredentialData(String) instead and use the subtype of CredentialData specific to your credential