public interface UserCredentialManager extends UserCredentialStore
Modifier and Type | Interface and Description |
---|---|
static interface |
UserCredentialManager.Streams
The
UserCredentialManager.Streams interface makes all collection-based methods in UserCredentialManager
default by providing implementations that delegate to the Stream -based variants instead of the other way around. |
Modifier and Type | Method and Description |
---|---|
CredentialValidationOutput |
authenticate(KeycloakSession session,
RealmModel realm,
CredentialInput input)
Given a CredentialInput, authenticate the user.
|
CredentialModel |
createCredentialThroughProvider(RealmModel realm,
UserModel user,
CredentialModel model)
Creates a credential from the credentialModel, by looping through the providers to find a match for the type
|
void |
disableCredentialType(RealmModel realm,
UserModel user,
String credentialType)
Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through
each CredentialProvider.
|
List<String> |
getConfiguredUserStorageCredentialTypes(RealmModel realm,
UserModel user)
Deprecated.
Use
getConfiguredUserStorageCredentialTypesStream
instead. |
default Stream<String> |
getConfiguredUserStorageCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types provided by the user storage where the specified user is stored.
|
Set<String> |
getDisableableCredentialTypes(RealmModel realm,
UserModel user)
Deprecated.
Use
getDisableableCredentialTypesStream
instead. |
default Stream<String> |
getDisableableCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types that can be disabled by means of the
disableCredentialType(RealmModel, UserModel, String)
method. |
boolean |
isConfiguredFor(RealmModel realm,
UserModel user,
String type)
Checks to see if user has credential type configured.
|
boolean |
isConfiguredLocally(RealmModel realm,
UserModel user,
String type)
Only loops through each CredentialProvider to see if credential type is configured for the user.
|
boolean |
isValid(RealmModel realm,
UserModel user,
CredentialInput... inputs)
Validates list of credentials.
|
boolean |
isValid(RealmModel realm,
UserModel user,
List<CredentialInput> inputs)
Validates list of credentials.
|
boolean |
updateCredential(RealmModel realm,
UserModel user,
CredentialInput input)
Updates a credential.
|
void |
updateCredentialLabel(RealmModel realm,
UserModel user,
String credentialId,
String userLabel)
Updates the credential label and invalidates the cache for the user.
|
createCredential, getStoredCredentialById, getStoredCredentialByNameAndType, getStoredCredentials, getStoredCredentialsByType, getStoredCredentialsByTypeStream, getStoredCredentialsStream, moveCredentialTo, removeStoredCredential, updateCredential
boolean isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)
realm
- user
- inputs
- boolean isValid(RealmModel realm, UserModel user, CredentialInput... inputs)
realm
- user
- inputs
- boolean updateCredential(RealmModel realm, UserModel user, CredentialInput input)
realm
- user
- CredentialModel createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)
realm
- user
- model
- void updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)
realm
- user
- credentialId
- userLabel
- void disableCredentialType(RealmModel realm, UserModel user, String credentialType)
realm
- user
- credentialType
- @Deprecated Set<String> getDisableableCredentialTypes(RealmModel realm, UserModel user)
getDisableableCredentialTypesStream
instead.realm
- user
- default Stream<String> getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
disableCredentialType(RealmModel, UserModel, String)
method.realm
- a reference to the realm.user
- the user whose credentials are being searched.Stream
of credential types.boolean isConfiguredFor(RealmModel realm, UserModel user, String type)
realm
- user
- type
- boolean isConfiguredLocally(RealmModel realm, UserModel user, String type)
realm
- user
- type
- CredentialValidationOutput authenticate(KeycloakSession session, RealmModel realm, CredentialInput input)
session
- realm
- input
- @Deprecated List<String> getConfiguredUserStorageCredentialTypes(RealmModel realm, UserModel user)
getConfiguredUserStorageCredentialTypesStream
instead.default Stream<String> getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)
realm
- a reference to the realm.user
- a reference to the user.Stream
of credential types.Copyright © 2021 JBoss by Red Hat. All rights reserved.