Package org.keycloak.models
Interface SubjectCredentialManager
- All Known Implementing Classes:
SubjectCredentialManagerCacheAdapter
,UserCredentialManager
public interface SubjectCredentialManager
Validates and manages the credentials of a known entity (for example, a user).
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Updates a credential of the entity with an updatedCredentialModel
.void
disableCredentialType
(String credentialType) Disable a credential by type.Deprecated.List the credentials that can be disabled, for example, to show the list to the entity (aka user) or an admin.Read a stored credential.getStoredCredentialByNameAndType
(String name, String type) Read stored credentials by type as a stream.Read stored credentials as a stream.boolean
isConfiguredFor
(String type) Check if the credential type is configured for this entity.boolean
isConfiguredLocally
(String type) Deprecated.boolean
isValid
(List<CredentialInput> inputs) Validate a list of credentials.default boolean
isValid
(CredentialInput... inputs) Validate a list of credentials.boolean
moveStoredCredentialTo
(String id, String newPreviousCredentialId) Re-order the stored credentials.boolean
Updates a credential of the entity with an updatedCredentialModel
.boolean
updateCredential
(CredentialInput input) Updates a credential of the entity with the inputs provided by the entity.void
updateCredentialLabel
(String credentialId, String credentialLabel) Update the label for a stored credentials chosen by the owner of the entity.void
Updates a credential of the entity with an updatedCredentialModel
.
-
Method Details
-
isValid
Validate a list of credentials.- Returns:
true
if inputs are valid
-
isValid
Validate a list of credentials.- Returns:
true
if inputs are valid
-
updateCredential
Updates a credential of the entity with the inputs provided by the entity.- Returns:
true
if credentials have been updated successfully
-
updateStoredCredential
Updates a credential of the entity with an updatedCredentialModel
. Usually called by aCredentialProvider
. -
createStoredCredential
Updates a credential of the entity with an updatedCredentialModel
. Usually called by aCredentialProvider
. -
removeStoredCredentialById
Updates a credential of the entity with an updatedCredentialModel
. Usually called by aCredentialProvider
, or from the account management when a user removes, for example, an OTP token. -
getStoredCredentialById
Read a stored credential. -
getStoredCredentialsStream
Stream<CredentialModel> getStoredCredentialsStream()Read stored credentials as a stream. -
getStoredCredentialsByTypeStream
Read stored credentials by type as a stream. -
getStoredCredentialByNameAndType
-
moveStoredCredentialTo
Re-order the stored credentials. -
updateCredentialLabel
Update the label for a stored credentials chosen by the owner of the entity. -
disableCredentialType
Disable a credential by type. -
getDisableableCredentialTypesStream
List the credentials that can be disabled, for example, to show the list to the entity (aka user) or an admin.- Returns:
- stream with credential types that can be disabled
-
isConfiguredFor
Check if the credential type is configured for this entity.- Parameters:
type
- credential type to check- Returns:
true
if the credential type has been
-
isConfiguredLocally
Deprecated. -
getConfiguredUserStorageCredentialTypesStream
Deprecated. -
createCredentialThroughProvider
Deprecated.
-