org.keycloak.models.UserCredentialManager インタフェース

org.keycloak.models.UserCredentialManager の継承関係図

org.keycloak.models.UserCredentialManager 連携図

公開メンバ関数
boolean	isValid (RealmModel realm, UserModel user, List< CredentialInput > inputs)
boolean	isValid (RealmModel realm, UserModel user, CredentialInput... inputs)
void	updateCredential (RealmModel realm, UserModel user, CredentialInput input)
void	disableCredentialType (RealmModel realm, UserModel user, String credentialType)
Set< String >	getDisableableCredentialTypes (RealmModel realm, UserModel user)
boolean	isConfiguredFor (RealmModel realm, UserModel user, String type)
boolean	isConfiguredLocally (RealmModel realm, UserModel user, String type)
CredentialValidationOutput	authenticate (KeycloakSession session, RealmModel realm, CredentialInput input)
void	updateCredential (RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	createCredential (RealmModel realm, UserModel user, CredentialModel cred)
boolean	removeStoredCredential (RealmModel realm, UserModel user, String id)
CredentialModel	getStoredCredentialById (RealmModel realm, UserModel user, String id)
List< CredentialModel >	getStoredCredentials (RealmModel realm, UserModel user)
List< CredentialModel >	getStoredCredentialsByType (RealmModel realm, UserModel user, String type)
CredentialModel	getStoredCredentialByNameAndType (RealmModel realm, UserModel user, String name, String type)
void	close ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

authenticate()

CredentialValidationOutput org.keycloak.models.UserCredentialManager.authenticate	(	KeycloakSession	session,
		RealmModel	realm,
		CredentialInput	input
	)

Given a CredentialInput, authenticate the user. This is used in the case where the credential must be processed to determine and find the user. An example is Kerberos where the kerberos token might be validated and processed by a variety of different storage providers.

引数

session
realm
input

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

close()

void org.keycloak.provider.Provider.close ( )

inherited

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProvider, org.keycloak.storage.UserStorageManager, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.storage.ldap.LDAPStorageProvider, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider, org.keycloak.models.cache.infinispan.RealmCacheSession, org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.models.jpa.session.JpaUserSessionPersisterProvider, org.keycloak.credential.UserCredentialStoreManager, org.keycloak.services.managers.DefaultBruteForceProtector, org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProvider, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider, org.keycloak.protocol.saml.EntityDescriptorDescriptionConverter, org.keycloak.federation.kerberos.KerberosFederationProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.storage.ClientStorageManager, org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProvider, org.keycloak.models.sessions.infinispan.InfinispanAuthenticationSessionProvider, org.keycloak.services.clientregistration.AbstractClientRegistrationProvider, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.email.DefaultEmailSenderProvider, org.keycloak.models.jpa.JpaRealmProvider, org.keycloak.exportimport.dir.DirImportProvider, org.keycloak.protocol.docker.DockerAuthV2Protocol, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authorization.AuthorizationProvider, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProvider, org.keycloak.theme.ExtendingThemeManager, org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation, org.keycloak.models.cache.infinispan.authorization.StoreFactoryCacheSession, org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.protocol.saml.mappers.RoleNameMapper, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.protocol.oidc.OIDCWellKnownProvider, org.keycloak.events.log.JBossLoggingEventListenerProvider, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.connections.jpa.updater.liquibase.conn.DefaultLiquibaseConnectionProvider, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.protocol.saml.installation.ModAuthMellonClientInstallation, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.credential.hash.Pbkdf2PasswordHashProvider, org.keycloak.events.jpa.JpaEventStoreProvider, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleUpdateTotp, org.keycloak.authentication.requiredactions.ConsoleVerifyEmail, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.authorization.protection.introspect.RPTIntrospectionProvider, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.models.UserProvider, org.keycloak.exportimport.dir.DirExportProvider, org.keycloak.models.UserSessionProvider, org.keycloak.scripting.DefaultScriptingProvider, org.keycloak.protocol.oidc.AccessTokenIntrospectionProvider, org.keycloak.protocol.saml.installation.SamlSPDescriptorClientInstallation, org.keycloak.exportimport.singlefile.SingleFileExportProvider, org.keycloak.exportimport.singlefile.SingleFileImportProvider, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.services.migration.DefaultMigrationProvider, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProvider, org.keycloak.timer.basic.BasicTimerProvider, org.keycloak.theme.FolderThemeProvider, org.keycloak.models.RealmProvider, org.keycloak.policy.HistoryPasswordPolicyProvider, org.keycloak.protocol.saml.installation.KeycloakSamlSubsystemInstallation, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.keys.AbstractGeneratedSecretKeyProvider, org.keycloak.authorization.jpa.store.JPAStoreFactory, org.keycloak.events.email.EmailEventListenerProvider, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.policy.BlacklistPasswordPolicyProvider, org.keycloak.authentication.authenticators.console.ConsoleOTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleTermsAndConditions, org.keycloak.models.sessions.infinispan.InfinispanCodeToTokenStoreProvider, org.keycloak.policy.RegexPatternsPasswordPolicyProvider, org.keycloak.models.sessions.infinispan.InfinispanStickySessionEncoderProvider, org.keycloak.cluster.infinispan.InfinispanClusterProvider, org.keycloak.authentication.requiredactions.ConsoleUpdateProfile, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.policy.DefaultPasswordPolicyManagerProvider, org.keycloak.services.x509.AbstractClientCertificateFromHttpHeadersLookup, org.keycloak.theme.ClasspathThemeProvider, org.keycloak.policy.DigitsPasswordPolicyProvider, org.keycloak.policy.LowerCasePasswordPolicyProvider, org.keycloak.policy.SpecialCharsPasswordPolicyProvider, org.keycloak.policy.UpperCasePasswordPolicyProvider, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.policy.NotUsernamePasswordPolicyProvider, org.keycloak.theme.DefaultThemeSelectorProvider, org.keycloak.connections.infinispan.DefaultInfinispanConnectionProvider, org.keycloak.provider.ExceptionConverter, org.keycloak.policy.LengthPasswordPolicyProvider, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.protocol.oidc.OIDCClientDescriptionConverter, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.models.sessions.infinispan.InfinispanActionTokenStoreProvider, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticator, org.keycloak.locale.DefaultLocaleSelectorProvider, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider, org.keycloak.truststore.FileTruststoreProvider, org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper, org.keycloak.authentication.authenticators.AttemptedAuthenticator, org.keycloak.authorization.policy.provider.drools.DroolsPolicyProvider, org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy, org.keycloak.services.x509.DefaultClientCertificateLookup, org.keycloak.connections.jpa.DefaultJpaConnectionProvider, org.keycloak.authorization.config.UmaWellKnownProvider, org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper, org.keycloak.urls.HostnameProvider, org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator, org.keycloak.keys.KeyProvider, org.keycloak.protocol.docker.installation.DockerRegistryConfigFileInstallationProvider, org.keycloak.protocol.docker.installation.DockerVariableOverrideInstallationProvider, org.keycloak.protocol.docker.mapper.DockerAuthV2ProtocolMapper, org.keycloak.transaction.JtaTransactionManagerLookup, org.keycloak.broker.provider.AbstractIdentityProviderMapper, org.keycloak.authentication.AbstractFormAuthenticator, org.keycloak.crypto.SignatureProvider, org.keycloak.credential.CredentialProvider, org.keycloak.protocol.oidc.ext.OIDCExtProvider (計143項目)で実装されています。

createCredential()

CredentialModel org.keycloak.credential.UserCredentialStore.createCredential ( RealmModel  realm, UserModel  user, CredentialModel  cred  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

disableCredentialType()

void org.keycloak.models.UserCredentialManager.disableCredentialType	(	RealmModel	realm,
		UserModel	user,
		String	credentialType
	)

Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.

引数

realm
user
credentialType

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

getDisableableCredentialTypes()

Set<String> org.keycloak.models.UserCredentialManager.getDisableableCredentialTypes	(	RealmModel	realm,
		UserModel	user
	)

Returns a set of credential types that can be disabled by disableCredentialType() method

引数

realm
user

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

getStoredCredentialById()

CredentialModel org.keycloak.credential.UserCredentialStore.getStoredCredentialById ( RealmModel  realm, UserModel  user, String  id  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

getStoredCredentialByNameAndType()

CredentialModel org.keycloak.credential.UserCredentialStore.getStoredCredentialByNameAndType ( RealmModel  realm, UserModel  user, String  name, String  type  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

getStoredCredentials()

List<CredentialModel> org.keycloak.credential.UserCredentialStore.getStoredCredentials ( RealmModel  realm, UserModel  user  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

getStoredCredentialsByType()

List<CredentialModel> org.keycloak.credential.UserCredentialStore.getStoredCredentialsByType ( RealmModel  realm, UserModel  user, String  type  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

isConfiguredFor()

boolean org.keycloak.models.UserCredentialManager.isConfiguredFor	(	RealmModel	realm,
		UserModel	user,
		String	type
	)

Checks to see if user has credential type configured. Looks in UserStorageProvider or UserFederationProvider first, then loops through each CredentialProvider.

引数

realm
user
type

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

isConfiguredLocally()

boolean org.keycloak.models.UserCredentialManager.isConfiguredLocally	(	RealmModel	realm,
		UserModel	user,
		String	type
	)

Only loops through each CredentialProvider to see if credential type is configured for the user. This allows UserStorageProvider and UserFederationProvider isValid() implementations to punt to local storage when validating a credential that has been overriden in Keycloak storage.

引数

realm
user
type

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

isValid() [1/2]

boolean org.keycloak.models.UserCredentialManager.isValid	(	RealmModel	realm,
		UserModel	user,
		List< CredentialInput >	inputs
	)

Validates list of credentials. Will call UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.

引数

realm
user
inputs

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

isValid() [2/2]

boolean org.keycloak.models.UserCredentialManager.isValid	(	RealmModel	realm,
		UserModel	user,
		CredentialInput...	inputs
	)

Validates list of credentials. Will call UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.

引数

realm
user
inputs

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

removeStoredCredential()

boolean org.keycloak.credential.UserCredentialStore.removeStoredCredential ( RealmModel  realm, UserModel  user, String  id  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.credential.UserCredentialStoreManagerで実装されています。

updateCredential() [1/2]

void org.keycloak.credential.UserCredentialStore.updateCredential ( RealmModel  realm, UserModel  user, CredentialModel  cred  )

inherited

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.credential.UserCredentialStoreManager, org.keycloak.models.jpa.JpaUserCredentialStoreで実装されています。

updateCredential() [2/2]

void org.keycloak.models.UserCredentialManager.updateCredential	(	RealmModel	realm,
		UserModel	user,
		CredentialInput	input
	)

Updates a credential. Will call UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider. Update is finished whenever any one provider returns true.

引数

realm
user

戻り値

org.keycloak.credential.UserCredentialStoreManagerで実装されています。

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/UserCredentialManager.java