Package org.keycloak.credential

Class UserCredentialManager

java.lang.Object

org.keycloak.storage.AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>

org.keycloak.credential.UserCredentialManager

All Implemented Interfaces:

SubjectCredentialManager

Direct Known Subclasses:

SubjectCredentialManagerCacheAdapter

public class UserCredentialManager
extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
implements SubjectCredentialManager

Handling credentials for a given user for the store.

Author:

Alexander Schwartz

Constructor Summary

Constructors

Constructor	Description
UserCredentialManager(KeycloakSession session, RealmModel realm, UserModel user)

Method Summary

Modifier and Type	Method	Description
CredentialModel	createCredentialThroughProvider(CredentialModel model)
CredentialModel	createStoredCredential(CredentialModel cred)	Updates a credential of the entity with an updated CredentialModel.
void	disableCredentialType(String credentialType)	Disable a credential by type.
Stream<String>	getConfiguredUserStorageCredentialTypesStream()
Stream<String>	getDisableableCredentialTypesStream()	List the credentials that can be disabled, for example, to show the list to the entity (aka user) or an admin.
Stream<CredentialModel>	getFederatedCredentialsStream()	Returns a stream consisting of the federated credentials.
CredentialModel	getStoredCredentialById(String id)	Read a stored credential.
CredentialModel	getStoredCredentialByNameAndType(String name, String type)
Stream<CredentialModel>	getStoredCredentialsByTypeStream(String type)	Read stored credentials by type as a stream.
Stream<CredentialModel>	getStoredCredentialsStream()	Read stored credentials as a stream.
boolean	isConfiguredFor(String type)	Check if the credential type is configured for this entity.
boolean	isConfiguredLocally(String type)
boolean	isValid(List<CredentialInput> inputs)	Validate a list of credentials.
boolean	moveStoredCredentialTo(String id, String newPreviousCredentialId)	Re-order the stored credentials.
boolean	removeStoredCredentialById(String id)	Updates a credential of the entity with an updated CredentialModel.
boolean	updateCredential(CredentialInput input)	Updates a credential of the entity with the inputs provided by the entity.
void	updateCredentialLabel(String credentialId, String userLabel)	Update the label for a stored credentials chosen by the owner of the entity.
void	updateStoredCredential(CredentialModel cred)	Updates a credential of the entity with an updated CredentialModel.

Methods inherited from class org.keycloak.storage.AbstractStorageManager

consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.SubjectCredentialManager

getCredentials, isValid

Constructor Details

UserCredentialManager

public UserCredentialManager(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Method Details

isValid

public boolean isValid(List<CredentialInput> inputs)

Description copied from interface: SubjectCredentialManager

Validate a list of credentials.

Specified by:

isValid in interface SubjectCredentialManager

Returns:

true if inputs are valid

updateCredential

public boolean updateCredential(CredentialInput input)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with the inputs provided by the entity.

Specified by:

updateCredential in interface SubjectCredentialManager

Returns:

true if credentials have been updated successfully

updateStoredCredential

public void updateStoredCredential(CredentialModel cred)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider.

Specified by:

updateStoredCredential in interface SubjectCredentialManager

createStoredCredential

public CredentialModel createStoredCredential(CredentialModel cred)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider.

Specified by:

createStoredCredential in interface SubjectCredentialManager

removeStoredCredentialById

public boolean removeStoredCredentialById(String id)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider, or from the account management when a user removes, for example, an OTP token.

Specified by:

removeStoredCredentialById in interface SubjectCredentialManager

getStoredCredentialById

public CredentialModel getStoredCredentialById(String id)

Description copied from interface: SubjectCredentialManager

Read a stored credential.

Specified by:

getStoredCredentialById in interface SubjectCredentialManager

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream()

Description copied from interface: SubjectCredentialManager

Read stored credentials as a stream.

Specified by:

getStoredCredentialsStream in interface SubjectCredentialManager

getFederatedCredentialsStream

public Stream<CredentialModel> getFederatedCredentialsStream()

Description copied from interface: SubjectCredentialManager

Returns a stream consisting of the federated credentials.

Specified by:

getFederatedCredentialsStream in interface SubjectCredentialManager

Returns:

a stream consisting of the federated credentials

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(String type)

Description copied from interface: SubjectCredentialManager

Read stored credentials by type as a stream.

Specified by:

getStoredCredentialsByTypeStream in interface SubjectCredentialManager

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface SubjectCredentialManager

moveStoredCredentialTo

public boolean moveStoredCredentialTo(String id,
 String newPreviousCredentialId)

Description copied from interface: SubjectCredentialManager

Re-order the stored credentials.

Specified by:

moveStoredCredentialTo in interface SubjectCredentialManager

updateCredentialLabel

public void updateCredentialLabel(String credentialId,
 String userLabel)

Description copied from interface: SubjectCredentialManager

Update the label for a stored credentials chosen by the owner of the entity.

Specified by:

updateCredentialLabel in interface SubjectCredentialManager

disableCredentialType

public void disableCredentialType(String credentialType)

Description copied from interface: SubjectCredentialManager

Disable a credential by type.

Specified by:

disableCredentialType in interface SubjectCredentialManager

getDisableableCredentialTypesStream

public Stream<String> getDisableableCredentialTypesStream()

Description copied from interface: SubjectCredentialManager

List the credentials that can be disabled, for example, to show the list to the entity (aka user) or an admin.

Specified by:

getDisableableCredentialTypesStream in interface SubjectCredentialManager

Returns:

stream with credential types that can be disabled

isConfiguredFor

public boolean isConfiguredFor(String type)

Description copied from interface: SubjectCredentialManager

Check if the credential type is configured for this entity.

Specified by:

isConfiguredFor in interface SubjectCredentialManager

Parameters:

type - credential type to check

Returns:

true if the credential type has been

isConfiguredLocally

public boolean isConfiguredLocally(String type)

Specified by:

isConfiguredLocally in interface SubjectCredentialManager

getConfiguredUserStorageCredentialTypesStream

public Stream<String> getConfiguredUserStorageCredentialTypesStream()

Specified by:

getConfiguredUserStorageCredentialTypesStream in interface SubjectCredentialManager

createCredentialThroughProvider

public CredentialModel createCredentialThroughProvider(CredentialModel model)

Specified by:

createCredentialThroughProvider in interface SubjectCredentialManager