org.keycloak.models

Class UserCredentialModel

java.lang.Object

org.keycloak.models.UserCredentialModel

All Implemented Interfaces:

CredentialInput

Direct Known Subclasses:

PasswordUserCredentialModel

public class UserCredentialModel
extends Object
implements CredentialInput

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected String	algorithm
static String	CLIENT_CERT
protected String	device
static String	HOTP
static String	KERBEROS
protected Map<String,Object>	notes
static String	PASSWORD
static String	PASSWORD_HISTORY
static String	PASSWORD_TOKEN
static String	SECRET
static String	TOTP
protected String	type
protected String	value

Constructor Summary

Constructors

Constructor and Description
UserCredentialModel()

Method Summary

Modifier and Type	Method and Description
static UserCredentialModel	generateSecret()
String	getAlgorithm()
String	getDevice()
Object	getNote(String key)
String	getType()
String	getValue()
static UserCredentialModel	hotp(String key)
static boolean	isOtp(String type)
static UserCredentialModel	kerberos(String token)
static UserCredentialModel	otp(String type, String key)
static PasswordUserCredentialModel	password(String password)
static PasswordUserCredentialModel	password(String password, boolean adminRequest)
static UserCredentialModel	passwordToken(String passwordToken)
void	removeNote(String key)
static UserCredentialModel	secret(String password)
void	setAlgorithm(String algorithm)
void	setDevice(String device)
void	setNote(String key, String value)
void	setType(String type)
void	setValue(String value)
static UserCredentialModel	totp(String key)

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

PASSWORD_HISTORY

public static final String PASSWORD_HISTORY

See Also:

Constant Field Values

PASSWORD_TOKEN

public static final String PASSWORD_TOKEN

See Also:

Constant Field Values

SECRET

public static final String SECRET

See Also:

Constant Field Values

TOTP

public static final String TOTP

See Also:

Constant Field Values

HOTP

public static final String HOTP

See Also:

Constant Field Values

CLIENT_CERT

public static final String CLIENT_CERT

See Also:

Constant Field Values

KERBEROS

public static final String KERBEROS

See Also:

Constant Field Values

type

protected String type

value

protected String value

device

protected String device

algorithm

protected String algorithm

notes

protected Map<String,Object> notes

Constructor Detail

UserCredentialModel

public UserCredentialModel()

Method Detail

password

public static PasswordUserCredentialModel password(String password)

password

public static PasswordUserCredentialModel password(String password,
                                                   boolean adminRequest)

passwordToken

public static UserCredentialModel passwordToken(String passwordToken)

secret

public static UserCredentialModel secret(String password)

otp

public static UserCredentialModel otp(String type,
                                      String key)

totp

public static UserCredentialModel totp(String key)

hotp

public static UserCredentialModel hotp(String key)

kerberos

public static UserCredentialModel kerberos(String token)

generateSecret

public static UserCredentialModel generateSecret()

isOtp

public static boolean isOtp(String type)

getType

public String getType()

Specified by:

getType in interface CredentialInput

setType

public void setType(String type)

getValue

public String getValue()

setValue

public void setValue(String value)

getDevice

public String getDevice()

setDevice

public void setDevice(String device)

getAlgorithm

public String getAlgorithm()

setAlgorithm

public void setAlgorithm(String algorithm)

setNote

public void setNote(String key,
                    String value)

removeNote

public void removeNote(String key)

getNote

public Object getNote(String key)