Skip navigation links
Keycloak Server SPI 2.4.0.CR1
A B C D E F G H I J K L M N O P Q R S T U V X 

A

AbstractUserAdapter - Class in org.keycloak.storage.adapter
This abstract class provides implementations for everything but getUsername().
AbstractUserAdapter(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapter
 
AbstractUserAdapter.ReadOnlyException - Exception in org.keycloak.storage.adapter
 
AbstractUserAdapterFederatedStorage - Class in org.keycloak.storage.adapter
Assumes everything is managed by federated storage except for username.
AbstractUserAdapterFederatedStorage(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
ACTION_SIGNATURE - Static variable in interface org.keycloak.models.ClientSessionModel
 
ActiveKey(String, PrivateKey, PublicKey, X509Certificate) - Constructor for class org.keycloak.models.KeyManager.ActiveKey
 
add(UserFederationSyncResult) - Method in class org.keycloak.models.UserFederationSyncResult
 
add() - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
add(SynchronizationResult) - Method in class org.keycloak.storage.user.SynchronizationResult
 
addAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
addAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
addAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
addChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
Automatically calls setParent() on the subGroup
addClient(String) - Method in interface org.keycloak.models.RealmModel
 
addClient(String, String) - Method in interface org.keycloak.models.RealmModel
 
addClient(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addClient(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientRole(RealmModel, ClientModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientTemplate(String) - Method in interface org.keycloak.models.RealmModel
 
addClientTemplate(String, String) - Method in interface org.keycloak.models.RealmModel
 
addComponentModel(ComponentModel) - Method in interface org.keycloak.models.RealmModel
Adds component model.
addCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
addConsent(RealmModel, String, UserConsentModel) - Method in class org.keycloak.models.UserFederationManager
 
addConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.models.UserProvider
 
addConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage
 
addDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
addDefaultRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
addDefaultRoles(RealmModel, UserModel) - Static method in class org.keycloak.models.utils.DefaultRoles
 
addFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in class org.keycloak.models.UserFederationManager
 
addFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
 
addFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
addGrantedProtocolMapper(ProtocolMapperModel) - Method in class org.keycloak.models.UserConsentModel
 
addGrantedRole(RoleModel) - Method in class org.keycloak.models.UserConsentModel
 
addIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
 
addIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
addProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
addReadTokenRoleOnCreate - Variable in class org.keycloak.models.IdentityProviderModel
 
addRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addRealmRole(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
 
addRequiredAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.ClientSessionModel
 
addRequiredAction(String) - Method in interface org.keycloak.models.UserModel
 
addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
 
addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
addRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage
 
addRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
addRequiredCredential(String) - Method in interface org.keycloak.models.RealmModel
 
addRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
addRole(String, String) - Method in interface org.keycloak.models.RoleContainerModel
 
addScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
addTopLevelGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
addUser(RealmModel, String, String, boolean, boolean) - Method in class org.keycloak.models.UserFederationManager
 
addUser(RealmModel, String) - Method in class org.keycloak.models.UserFederationManager
 
addUser(RealmModel, String, String, boolean, boolean) - Method in interface org.keycloak.models.UserProvider
only used for local storage
addUser(RealmModel, String) - Method in interface org.keycloak.storage.user.UserRegistrationProvider
 
addUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
addUserFederationProvider(String, Map<String, String>, int, String, int, int, int) - Method in interface org.keycloak.models.RealmModel
 
addUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
addWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
 
algorithm - Variable in class org.keycloak.models.OTPPolicy
 
algorithm - Variable in class org.keycloak.models.UserCredentialModel
 
algorithm - Variable in class org.keycloak.models.utils.HmacOTP
 
appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true
appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true
appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true
appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true
authenticate(RealmModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialAuthentication
 
authenticate(KeycloakSession, RealmModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager
Given a CredentialInput, authenticate the user.
AuthenticationExecutionModel - Class in org.keycloak.models
 
AuthenticationExecutionModel() - Constructor for class org.keycloak.models.AuthenticationExecutionModel
 
AuthenticationExecutionModel.ExecutionComparator - Class in org.keycloak.models
 
AuthenticationExecutionModel.Requirement - Enum in org.keycloak.models
 
AuthenticationFlowModel - Class in org.keycloak.models
 
AuthenticationFlowModel() - Constructor for class org.keycloak.models.AuthenticationFlowModel
 
AuthenticatorConfigModel - Class in org.keycloak.models
 
AuthenticatorConfigModel() - Constructor for class org.keycloak.models.AuthenticatorConfigModel
 

B

Base32 - Class in org.keycloak.models.utils
Base32 - encodes and decodes RFC3548 Base32 (see http://www.faqs.org/rfcs/rfc3548.html )
Base32() - Constructor for class org.keycloak.models.utils.Base32
 
begin() - Method in interface org.keycloak.models.KeycloakTransaction
 
BOOLEAN_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
build() - Method in class org.keycloak.provider.ProviderConfigurationBuilder
 
BUILT_IN - Static variable in class org.keycloak.models.RequiredCredentialModel
 

C

CachedUserModel - Interface in org.keycloak.models.cache
Cached users will implement this interface
ClaimTypeModel - Class in org.keycloak.models
 
ClaimTypeModel(ClaimTypeModel) - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel(String, String, boolean, ClaimTypeModel.ValueType) - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel() - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel.ValueType - Enum in org.keycloak.models
 
clear() - Method in interface org.keycloak.models.cache.UserCache
 
clearExecutionStatus() - Method in interface org.keycloak.models.ClientSessionModel
 
clearFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
clearUserSessionNotes() - Method in interface org.keycloak.models.ClientSessionModel
 
CLIENT_CERT - Static variable in class org.keycloak.credential.CredentialModel
 
CLIENT_CERT - Static variable in class org.keycloak.models.RequiredCredentialModel
 
CLIENT_CERT - Static variable in class org.keycloak.models.UserCredentialModel
 
CLIENT_LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
ClientInitialAccessModel - Interface in org.keycloak.models
 
ClientModel - Interface in org.keycloak.models
 
ClientSessionModel - Interface in org.keycloak.models
 
ClientSessionModel.Action - Enum in org.keycloak.models
 
ClientSessionModel.ExecutionStatus - Enum in org.keycloak.models
 
ClientTemplateModel - Interface in org.keycloak.models
 
close() - Method in interface org.keycloak.credential.CredentialProvider
 
close() - Method in interface org.keycloak.models.KeycloakSession
 
close() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
close() - Method in interface org.keycloak.models.RealmProvider
 
close() - Method in class org.keycloak.models.UserFederationManager
 
close() - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
This method is called at the end of requests.
close() - Method in interface org.keycloak.models.UserProvider
 
close() - Method in interface org.keycloak.models.UserSessionProvider
 
close() - Method in interface org.keycloak.provider.Provider
 
close() - Method in interface org.keycloak.provider.ProviderFactory
This is called when the server shuts down.
close() - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
commit() - Method in interface org.keycloak.models.KeycloakTransaction
 
commonConfig() - Static method in class org.keycloak.storage.UserStorageProviderSpi
 
comparator - Static variable in class org.keycloak.component.PrioritizedComponentModel
 
compare(AuthenticationExecutionModel, AuthenticationExecutionModel) - Method in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
ComponentFactory<CreatedType,ProviderType extends Provider> - Interface in org.keycloak.component
 
ComponentModel - Class in org.keycloak.component
Stored configuration of a User Storage provider instance.
ComponentModel() - Constructor for class org.keycloak.component.ComponentModel
 
ComponentModel(ComponentModel) - Constructor for class org.keycloak.component.ComponentModel
 
ComponentValidationException - Exception in org.keycloak.component
 
ComponentValidationException() - Constructor for exception org.keycloak.component.ComponentValidationException
 
ComponentValidationException(String, Object...) - Constructor for exception org.keycloak.component.ComponentValidationException
 
ComponentValidationException(String, Throwable) - Constructor for exception org.keycloak.component.ComponentValidationException
 
ComponentValidationException(Throwable) - Constructor for exception org.keycloak.component.ComponentValidationException
 
ComponentValidationException(String, Throwable, boolean, boolean) - Constructor for exception org.keycloak.component.ComponentValidationException
 
config - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
config - Variable in class org.keycloak.models.ProtocolMapperModel
 
config - Variable in class org.keycloak.models.UserFederationMapperModel
 
ConfiguredComponent - Interface in org.keycloak.component
 
ConfiguredProvider - Interface in org.keycloak.provider
 
consentRequired - Variable in class org.keycloak.models.ProtocolMapperModel
 
consentText - Variable in class org.keycloak.models.ProtocolMapperModel
 
contains(String) - Method in class org.keycloak.component.ComponentModel
 
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
 
create(KeycloakSession) - Method in interface org.keycloak.component.ComponentFactory
 
create() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
create(KeycloakSession) - Method in interface org.keycloak.models.UserFederationProviderFactory
This method is never called and is only an artifact of ProviderFactory.
create() - Static method in class org.keycloak.provider.ProviderConfigurationBuilder
 
create(KeycloakSession) - Method in interface org.keycloak.provider.ProviderFactory
 
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory
called per Keycloak transaction.
createClientInitialAccessModel(RealmModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
createClientSession(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
createCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore
 
createCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
created - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter
 
CREATED_TIMESTAMP_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
createGroup(String) - Method in interface org.keycloak.models.RealmModel
 
createGroup(String, String) - Method in interface org.keycloak.models.RealmModel
 
createGroup(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
createGroup(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
createOfflineClientSession(ClientSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
createOfflineUserSession(UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
createRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
createRealm(String, String) - Method in interface org.keycloak.models.RealmProvider
 
createUserSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionProvider
 
CredentialAuthentication - Interface in org.keycloak.credential
Single purpose method that knows how to authenticate a user based on a credential type.
CredentialInput - Interface in org.keycloak.credential
 
CredentialInputUpdater - Interface in org.keycloak.credential
 
CredentialInputValidator - Interface in org.keycloak.credential
 
CredentialModel - Class in org.keycloak.credential
Used just in cases when we want to "directly" update or retrieve the hash or salt of user credential (For example during export/import)
CredentialModel() - Constructor for class org.keycloak.credential.CredentialModel
 
CredentialProvider - Interface in org.keycloak.credential
 
CredentialValidationOutput - Class in org.keycloak.models
Output of credential validation
CredentialValidationOutput(UserModel, CredentialValidationOutput.Status, Map<String, String>) - Constructor for class org.keycloak.models.CredentialValidationOutput
 
CredentialValidationOutput.Status - Enum in org.keycloak.models
 

D

decode(String) - Static method in class org.keycloak.models.utils.Base32
Decodes the given Base32 String to a raw byte array.
decreaseRemainingCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
DEFAULT_ALGORITHM - Static variable in class org.keycloak.models.utils.HmacOTP
 
DEFAULT_NUMBER_DIGITS - Static variable in class org.keycloak.models.utils.HmacOTP
 
DEFAULT_POLICY - Static variable in class org.keycloak.models.OTPPolicy
 
DefaultRoles - Class in org.keycloak.models.utils
 
DefaultRoles() - Constructor for class org.keycloak.models.utils.DefaultRoles
 
defaultValue - Variable in class org.keycloak.provider.ProviderConfigProperty
 
defaultValue(Object) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
deleteInvalidUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
deleteRoleMapping(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
Removes the given role mapping from this object.
deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
deleteRoleMapping(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage
 
deleteScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
device - Variable in class org.keycloak.models.UserCredentialModel
 
digits - Variable in class org.keycloak.models.OTPPolicy
 
disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputUpdater
 
disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.

E

EMAIL - Static variable in interface org.keycloak.models.UserFederationProvider
Deprecated.
 
EMAIL - Static variable in interface org.keycloak.models.UserModel
 
EMAIL_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
EMAIL_VERIFIED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
empty() - Static method in class org.keycloak.models.PasswordPolicy
 
empty() - Static method in class org.keycloak.models.UserFederationSyncResult
 
empty() - Static method in class org.keycloak.storage.user.SynchronizationResult
 
ENABLED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
encode(String, PasswordPolicy, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
 
encode(byte[]) - Static method in class org.keycloak.models.utils.Base32
Encodes byte array to Base32 String.
enlist(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
enlistAfterCompletion(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
enlistForClose(Provider) - Method in interface org.keycloak.models.KeycloakSession
 
enlistPrepare(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
equals(Object) - Method in class org.keycloak.models.ClaimTypeModel
 
equals(Object) - Method in class org.keycloak.models.FederatedIdentityModel
 
equals(Object) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
equals(Object) - Method in class org.keycloak.models.ProtocolMapperModel
 
equals(Object) - Method in class org.keycloak.models.UserFederationMapperModel
 
equals(Object) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
equals(Object) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
evict(RealmModel, UserModel) - Method in interface org.keycloak.models.cache.UserCache
Evict user from cache.
evict(RealmModel) - Method in interface org.keycloak.models.cache.UserCache
Evict users of a specific realm
ExecutionComparator() - Constructor for class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
externalId(String) - Static method in class org.keycloak.storage.StorageId
 

F

failed() - Static method in class org.keycloak.models.CredentialValidationOutput
 
FederatedIdentityModel - Class in org.keycloak.models
 
FederatedIdentityModel(String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
 
FederatedIdentityModel(String, String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
 
federationMapperType - Variable in class org.keycloak.models.UserFederationMapperModel
 
federationProviderId - Variable in class org.keycloak.models.UserFederationMapperModel
 
FILE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
FIRST_NAME - Static variable in interface org.keycloak.models.UserFederationProvider
Deprecated.
 
FIRST_NAME - Static variable in interface org.keycloak.models.UserModel
 
FIRST_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
FORCE_EXPIRED_ID - Static variable in class org.keycloak.models.PasswordPolicy
 
formLabel - Variable in class org.keycloak.models.RequiredCredentialModel
 

G

generateHOTP(String, int) - Method in class org.keycloak.models.utils.HmacOTP
 
generateOTP(String, String, int, String) - Method in class org.keycloak.models.utils.HmacOTP
This method generates an OTP value for the given set of parameters.
generateSecret() - Static method in class org.keycloak.models.UserCredentialModel
 
generateSecret(int) - Static method in class org.keycloak.models.utils.HmacOTP
 
get(String) - Method in class org.keycloak.component.ComponentModel
 
get(String, int) - Method in class org.keycloak.component.ComponentModel
 
get(String, long) - Method in class org.keycloak.component.ComponentModel
 
get(String, boolean) - Method in class org.keycloak.component.ComponentModel
 
getAccessCodeLifespan() - Method in interface org.keycloak.models.RealmModel
 
getAccessCodeLifespanLogin() - Method in interface org.keycloak.models.RealmModel
 
getAccessCodeLifespanUserAction() - Method in interface org.keycloak.models.RealmModel
 
getAccessTokenLifespan() - Method in interface org.keycloak.models.RealmModel
 
getAccessTokenLifespanForImplicitFlow() - Method in interface org.keycloak.models.RealmModel
 
getAccountTheme() - Method in interface org.keycloak.models.RealmModel
 
getAction() - Method in interface org.keycloak.models.ClientSessionModel
 
getActiveKey(RealmModel) - Method in interface org.keycloak.models.KeyManager
 
getActiveUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getAdded() - Method in class org.keycloak.models.UserFederationSyncResult
 
getAdded() - Method in class org.keycloak.storage.user.SynchronizationResult
 
getAdminTheme() - Method in interface org.keycloak.models.RealmModel
 
getAlgorithm() - Method in class org.keycloak.credential.CredentialModel
 
getAlgorithm() - Method in class org.keycloak.models.OTPPolicy
 
getAlgorithm() - Method in class org.keycloak.models.UserCredentialModel
 
getAlias() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getAlias() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getAlias() - Method in class org.keycloak.models.IdentityProviderModel
 
getAlias() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getAllProviders(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
 
getAttribute(String) - Method in interface org.keycloak.models.ClientModel
 
getAttribute(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
getAttribute(String) - Method in interface org.keycloak.models.GroupModel
 
getAttribute(String) - Method in interface org.keycloak.models.KeycloakSession
 
getAttribute(String) - Method in interface org.keycloak.models.RealmModel
 
getAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel
 
getAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel
 
getAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel
 
getAttribute(String) - Method in interface org.keycloak.models.UserModel
 
getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getAttributes() - Method in interface org.keycloak.models.ClientModel
 
getAttributes() - Method in interface org.keycloak.models.ClientTemplateModel
 
getAttributes() - Method in interface org.keycloak.models.GroupModel
 
getAttributes() - Method in interface org.keycloak.models.RealmModel
 
getAttributes() - Method in interface org.keycloak.models.UserModel
 
getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getAttributes(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage
 
getAuthenticatedUser() - Method in interface org.keycloak.models.ClientSessionModel
 
getAuthenticatedUser() - Method in class org.keycloak.models.CredentialValidationOutput
 
getAuthenticationExecutionById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationExecutions(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationFlowById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationFlows() - Method in interface org.keycloak.models.RealmModel
 
getAuthenticator() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getAuthenticatorConfig() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getAuthenticatorConfigByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticatorConfigById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticatorConfigs() - Method in interface org.keycloak.models.RealmModel
 
getAuthMethod() - Method in interface org.keycloak.models.ClientSessionModel
Authentication request type, i.e.
getAuthMethod() - Method in interface org.keycloak.models.UserSessionModel
 
getAuthServerUrl() - Method in interface org.keycloak.models.KeycloakContext
 
getAuthStatus() - Method in class org.keycloak.models.CredentialValidationOutput
 
getBaseUrl() - Method in interface org.keycloak.models.ClientModel
 
getBrokerSessionId() - Method in interface org.keycloak.models.UserSessionModel
If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession
getBrokerUserId() - Method in interface org.keycloak.models.UserSessionModel
 
getBrowserFlow() - Method in interface org.keycloak.models.RealmModel
 
getBrowserSecurityHeaders() - Method in interface org.keycloak.models.RealmModel
 
getCachedWith() - Method in interface org.keycloak.models.cache.CachedUserModel
Returns a map that contains custom things that are cached along with this model.
getCacheInvalidBefore() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getCachePolicy() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedUserModel
When was the model was loaded from database.
getCertificate() - Method in class org.keycloak.keys.KeyMetadata
 
getCertificate() - Method in class org.keycloak.models.KeyManager.ActiveKey
 
getCertificate(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
 
getChangedSyncPeriod() - Method in class org.keycloak.models.UserFederationProviderModel
 
getChangedSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getClient() - Method in interface org.keycloak.models.ClientSessionModel
 
getClient() - Method in interface org.keycloak.models.KeycloakContext
 
getClient() - Method in interface org.keycloak.models.RealmModel.ClientRemovedEvent
 
getClient() - Method in class org.keycloak.models.UserConsentModel
 
getClientAuthenticationFlow() - Method in interface org.keycloak.models.RealmModel
 
getClientAuthenticatorType() - Method in interface org.keycloak.models.ClientModel
 
getClientByClientId(String) - Method in interface org.keycloak.models.RealmModel
 
getClientByClientId(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientById(String) - Method in interface org.keycloak.models.RealmModel
 
getClientById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientId() - Method in interface org.keycloak.models.ClientModel
 
getClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
 
getClientRoleMappings(ClientModel) - Method in interface org.keycloak.models.RoleMapperModel
Returns set of client roles that are directly set to this object for the given client.
getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getClientRoles(RealmModel, ClientModel) - Method in interface org.keycloak.models.RealmProvider
 
getClients() - Method in interface org.keycloak.models.RealmModel
 
getClients(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getClientSession(String) - Method in interface org.keycloak.models.UserSessionProvider
 
getClientSessions() - Method in interface org.keycloak.models.UserSessionModel
 
getClientTemplate() - Method in interface org.keycloak.models.ClientModel
 
getClientTemplateById(String) - Method in interface org.keycloak.models.RealmModel
 
getClientTemplateById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientTemplates() - Method in interface org.keycloak.models.RealmModel
 
getCode() - Method in interface org.keycloak.models.ScriptModel
Returns the actual source code of the script.
getCommonProviderConfigProperties() - Method in interface org.keycloak.component.ComponentFactory
These are config properties that are common across all implementation of this component type
getCommonProviderConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory
configuration properties that are common across all UserStorageProvider implementations
getComponent(String) - Method in interface org.keycloak.models.RealmModel
 
getComponents(String, String) - Method in interface org.keycloak.models.RealmModel
 
getComponents(String) - Method in interface org.keycloak.models.RealmModel
 
getComponents() - Method in interface org.keycloak.models.RealmModel
 
getComposites() - Method in interface org.keycloak.models.RoleModel
 
getConfig() - Method in class org.keycloak.component.ComponentModel
 
getConfig() - Method in class org.keycloak.credential.CredentialModel
 
getConfig() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getConfig() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getConfig() - Method in class org.keycloak.models.IdentityProviderModel
 
getConfig() - Method in class org.keycloak.models.ProtocolMapperModel
 
getConfig() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getConfig() - Method in class org.keycloak.models.UserFederationMapperModel
 
getConfig() - Method in class org.keycloak.models.UserFederationProviderModel
 
getConfigProperties(RealmModel, ComponentModel) - Method in interface org.keycloak.component.SubComponentFactory
 
getConfigProperties() - Method in interface org.keycloak.provider.ConfiguredProvider
 
getConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
getConfigurationOptions() - Method in interface org.keycloak.models.UserFederationProviderFactory
Config options to display in generic admin console page for federation
getConnection() - Method in interface org.keycloak.models.KeycloakContext
 
getConsentByClient(RealmModel, String, String) - Method in class org.keycloak.models.UserFederationManager
 
getConsentByClient(RealmModel, String, String) - Method in interface org.keycloak.models.UserProvider
 
getConsentByClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage
 
getConsents(RealmModel, String) - Method in class org.keycloak.models.UserFederationManager
 
getConsents(RealmModel, String) - Method in interface org.keycloak.models.UserProvider
 
getConsents(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage
 
getConsentText() - Method in class org.keycloak.models.ProtocolMapperModel
 
getContainer() - Method in interface org.keycloak.models.RoleModel
 
getContainerId() - Method in interface org.keycloak.models.RoleModel
 
getContext() - Method in interface org.keycloak.models.KeycloakSession
 
getContextObject(Class<T>) - Method in interface org.keycloak.models.KeycloakContext
 
getContextPath() - Method in interface org.keycloak.models.KeycloakContext
 
getCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getCounter() - Method in class org.keycloak.credential.CredentialModel
 
getCreatedClient() - Method in interface org.keycloak.models.RealmModel.ClientCreationEvent
 
getCreatedDate() - Method in class org.keycloak.credential.CredentialModel
 
getCreatedDate() - Method in class org.keycloak.models.UserConsentModel
 
getCreatedFederationProvider() - Method in interface org.keycloak.models.RealmModel.UserFederationProviderCreationEvent
 
getCreatedRealm() - Method in interface org.keycloak.models.RealmModel.RealmCreationEvent
 
getCreatedRealm() - Method in interface org.keycloak.models.RealmModel.RealmPostCreateEvent
 
getCreatedTimestamp() - Method in interface org.keycloak.models.UserModel
Get timestamp of user creation.
getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getDaysToExpirePassword() - Method in class org.keycloak.models.PasswordPolicy
 
getDefaultGroups() - Method in interface org.keycloak.models.RealmModel
 
getDefaultLocale() - Method in interface org.keycloak.models.RealmModel
 
getDefaultRoles() - Method in interface org.keycloak.models.RoleContainerModel
 
getDefaultRoles(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRoles
 
getDefaultValue() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getDelegateForUpdate() - Method in interface org.keycloak.models.cache.CachedUserModel
Invalidates the cache for this user and returns a delegate that represents the actual data provider
getDescription() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getDescription() - Method in interface org.keycloak.models.ClientModel
 
getDescription() - Method in interface org.keycloak.models.ClientTemplateModel
 
getDescription() - Method in interface org.keycloak.models.RoleModel
 
getDescription() - Method in interface org.keycloak.models.ScriptModel
Returns the description of the script.
getDevice() - Method in class org.keycloak.credential.CredentialModel
 
getDevice() - Method in class org.keycloak.models.UserCredentialModel
 
getDigits() - Method in class org.keycloak.credential.CredentialModel
 
getDigits() - Method in class org.keycloak.models.OTPPolicy
 
getDirectGrantFlow() - Method in interface org.keycloak.models.RealmModel
 
getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.credential.CredentialInputUpdater
Returns a set of credential types that can be disabled by disableCredentialType() method
getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager
Returns a set of credential types that can be disabled by disableCredentialType() method
getDisplayName() - Method in class org.keycloak.models.IdentityProviderModel
 
getDisplayName() - Method in interface org.keycloak.models.RealmModel
 
getDisplayName() - Method in class org.keycloak.models.UserFederationProviderModel
 
getDisplayNameHtml() - Method in interface org.keycloak.models.RealmModel
 
getEmail() - Method in interface org.keycloak.models.UserModel
 
getEmail() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getEmail() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getEmailTheme() - Method in interface org.keycloak.models.RealmModel
 
getEnabledEventTypes() - Method in interface org.keycloak.models.RealmModel
 
getEventsExpiration() - Method in interface org.keycloak.models.RealmModel
 
getEventsListeners() - Method in interface org.keycloak.models.RealmModel
 
getEvictionDay() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getEvictionHour() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getEvictionMinute() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getExecutionStatus() - Method in interface org.keycloak.models.ClientSessionModel
 
getExpiration() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getExpiredPasswords() - Method in class org.keycloak.models.PasswordPolicy
 
getExternalId() - Method in class org.keycloak.storage.StorageId
 
getFailed() - Method in class org.keycloak.models.UserFederationSyncResult
 
getFailed() - Method in class org.keycloak.storage.user.SynchronizationResult
 
getFailedLoginNotBefore() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getFailureFactor() - Method in interface org.keycloak.models.RealmModel
 
getFederatedIdentities(UserModel, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederatedIdentities(UserModel, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getFederatedIdentities(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
getFederatedIdentity(UserModel, String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederatedIdentity(UserModel, String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getFederatedIdentity(String, String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
getFederatedRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getFederatedStorage() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getFederationLink(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederationLink() - Method in interface org.keycloak.models.UserModel
 
getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
This method should not be overriden
getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
This method should not be overriden
getFederationMapperType() - Method in class org.keycloak.models.UserFederationMapperModel
 
getFederationProvider(UserFederationProviderModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederationProviderId() - Method in class org.keycloak.models.UserFederationMapperModel
 
getFirstAttribute(String) - Method in interface org.keycloak.models.GroupModel
 
getFirstAttribute(String) - Method in interface org.keycloak.models.UserModel
 
getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getFirstBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
 
getFirstName() - Method in interface org.keycloak.models.UserModel
 
getFirstName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getFirstName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getFlowByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getFlowId() - Method in class org.keycloak.models.AuthenticationExecutionModel
If this execution is a flow, this is the flowId pointing to an AuthenticationFlowModel
getFormLabel() - Method in class org.keycloak.models.RequiredCredentialModel
 
getFullSyncPeriod() - Method in class org.keycloak.models.UserFederationProviderModel
 
getFullSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getGrantedProtocolMappers() - Method in class org.keycloak.models.UserConsentModel
 
getGrantedRoles() - Method in class org.keycloak.models.UserConsentModel
 
getGroupById(String) - Method in interface org.keycloak.models.RealmModel
 
getGroupById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getGroupMembers(RealmModel, GroupModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
getGroupMembers(RealmModel, GroupModel) - Method in class org.keycloak.models.UserFederationManager
 
getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Return group members from federation storage.
getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
getGroupMembers(RealmModel, GroupModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
getGroups() - Method in interface org.keycloak.models.RealmModel
 
getGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getGroups() - Method in interface org.keycloak.models.UserModel
 
getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getGroups(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
 
getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
Get group membership mappings that are managed by this storage provider
getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
Get group membership mappings that are managed by this storage provider
getHashAlgorithm() - Method in class org.keycloak.models.PasswordPolicy
 
getHashIterations() - Method in class org.keycloak.credential.CredentialModel
 
getHashIterations() - Method in class org.keycloak.models.PasswordPolicy
 
getHelpText() - Method in interface org.keycloak.provider.ConfiguredProvider
 
getHelpText() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getHelpText() - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
getId() - Method in class org.keycloak.component.ComponentModel
 
getId() - Method in class org.keycloak.credential.CredentialModel
 
getId() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getId() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getId() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getId() - Method in class org.keycloak.models.ClaimTypeModel
 
getId() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getId() - Method in interface org.keycloak.models.ClientModel
 
getId() - Method in interface org.keycloak.models.ClientSessionModel
 
getId() - Method in interface org.keycloak.models.ClientTemplateModel
 
getId() - Method in interface org.keycloak.models.GroupModel
 
getId() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getId() - Method in class org.keycloak.models.ProtocolMapperModel
 
getId() - Method in interface org.keycloak.models.RealmModel
 
getId() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getId() - Method in interface org.keycloak.models.RoleContainerModel
 
getId() - Method in interface org.keycloak.models.RoleModel
 
getId() - Method in interface org.keycloak.models.ScriptModel
Returns the unique id of the script.
getId() - Method in class org.keycloak.models.UserFederationMapperModel
 
getId() - Method in interface org.keycloak.models.UserFederationProviderFactory
This is the name of the provider and will be showed in the admin console as an option.
getId() - Method in class org.keycloak.models.UserFederationProviderModel
 
getId() - Method in interface org.keycloak.models.UserModel
 
getId() - Method in interface org.keycloak.models.UserSessionModel
 
getId() - Method in interface org.keycloak.provider.ProviderFactory
 
getId() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()
getId() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()
getId() - Method in class org.keycloak.storage.StorageId
 
getId() - Method in interface org.keycloak.storage.UserStorageProviderFactory
This is the name of the provider and will be showed in the admin console as an option.
getIdentityProvider() - Method in class org.keycloak.models.FederatedIdentityModel
 
getIdentityProviderAlias() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMapper() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getIdentityProviderMapperById(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMappers() - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMappersByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviders() - Method in interface org.keycloak.models.RealmModel
 
getInitialCounter() - Method in class org.keycloak.models.OTPPolicy
 
getInstance(KeycloakSession, UserFederationProviderModel) - Method in interface org.keycloak.models.UserFederationProviderFactory
called per Keycloak transaction.
getInternalId() - Method in class org.keycloak.models.IdentityProviderModel
 
getIpAddress() - Method in interface org.keycloak.models.UserSessionModel
 
getJTAPolicy() - Method in interface org.keycloak.models.KeycloakTransactionManager
 
getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.ClientRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.ClientUpdatedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmPostCreateEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
 
getKeycloakSessionFactory() - Method in interface org.keycloak.models.KeycloakSession
 
getKeys(RealmModel, boolean) - Method in interface org.keycloak.models.KeyManager
 
getKeyURI(RealmModel, UserModel, String) - Method in class org.keycloak.models.OTPPolicy
Constructs the otpauth:// URI based on the Key-Uri-Format.
getKid() - Method in class org.keycloak.keys.KeyMetadata
 
getKid() - Method in class org.keycloak.models.KeyManager.ActiveKey
 
getLabel() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getLastFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getLastIPFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getLastName() - Method in interface org.keycloak.models.UserModel
 
getLastName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getLastName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getLastSessionRefresh() - Method in interface org.keycloak.models.UserSessionModel
 
getLastSync() - Method in class org.keycloak.models.UserFederationProviderModel
 
getLastSync() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getLastUpdatedDate() - Method in class org.keycloak.models.UserConsentModel
 
getLoginTheme() - Method in interface org.keycloak.models.RealmModel
 
getLoginUsername() - Method in interface org.keycloak.models.UserSessionModel
 
getLookAheadWindow() - Method in class org.keycloak.models.OTPPolicy
 
getManagementUrl() - Method in interface org.keycloak.models.ClientModel
 
getMasterAdminClient() - Method in interface org.keycloak.models.RealmModel
 
getMaxDeltaTimeSeconds() - Method in interface org.keycloak.models.RealmModel
 
getMaxFailureWaitSeconds() - Method in interface org.keycloak.models.RealmModel
 
getMaxLifespan() - Method in class org.keycloak.storage.UserStorageProviderModel
 
getMembership(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
 
getMessage() - Method in class org.keycloak.policy.PolicyError
 
getMigrationModel() - Method in interface org.keycloak.models.RealmProvider
 
getMimeType() - Method in interface org.keycloak.models.ScriptModel
Returns the MIME-type if the script code, e.g.
getMinimumQuickLoginWaitSeconds() - Method in interface org.keycloak.models.RealmModel
 
getName() - Method in class org.keycloak.component.ComponentModel
 
getName() - Method in class org.keycloak.models.ClaimTypeModel
 
getName() - Method in interface org.keycloak.models.ClientModel
 
getName() - Method in interface org.keycloak.models.ClientTemplateModel
 
getName() - Method in interface org.keycloak.models.GroupModel
 
getName() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getName() - Method in class org.keycloak.models.ProtocolMapperModel
 
getName() - Method in interface org.keycloak.models.RealmModel
 
getName() - Method in class org.keycloak.models.RequiredActionProviderModel
Used for display purposes.
getName() - Method in interface org.keycloak.models.RoleModel
 
getName() - Method in interface org.keycloak.models.ScriptModel
Returns the name of the script.
getName() - Method in class org.keycloak.models.UserFederationMapperModel
 
getName() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getName() - Method in interface org.keycloak.provider.Spi
 
getName() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi
 
getName() - Method in class org.keycloak.storage.UserStorageProviderSpi
 
getNodeReRegistrationTimeout() - Method in interface org.keycloak.models.ClientModel
 
getNotBefore() - Method in interface org.keycloak.models.ClientModel
Time in seconds since epoc
getNotBefore() - Method in interface org.keycloak.models.RealmModel
Time in seconds since epoc
getNote(String) - Method in class org.keycloak.component.ComponentModel
 
getNote(String) - Method in interface org.keycloak.models.ClientSessionModel
 
getNote(String) - Method in interface org.keycloak.models.UserSessionModel
 
getNotes() - Method in interface org.keycloak.models.ClientSessionModel
 
getNotes() - Method in interface org.keycloak.models.UserSessionModel
 
getNumFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getOfflineClientSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineClientSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
 
getOfflineSessionsCount(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
getOptions() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getOTPPolicy() - Method in interface org.keycloak.models.RealmModel
 
getParameters() - Method in exception org.keycloak.component.ComponentValidationException
 
getParameters() - Method in class org.keycloak.policy.PolicyError
 
getParent() - Method in interface org.keycloak.models.GroupModel
 
getParentFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getParentId() - Method in class org.keycloak.component.ComponentModel
 
getParentId() - Method in interface org.keycloak.models.GroupModel
 
getPasswordPolicy() - Method in interface org.keycloak.models.RealmModel
 
getPeriod() - Method in class org.keycloak.credential.CredentialModel
 
getPeriod() - Method in class org.keycloak.models.OTPPolicy
 
getPolicies() - Method in class org.keycloak.models.PasswordPolicy
 
getPolicyConfig(String) - Method in class org.keycloak.models.PasswordPolicy
 
getPostBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
 
getPriority() - Method in class org.keycloak.component.PrioritizedComponentModel
 
getPriority() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getPriority() - Method in class org.keycloak.models.UserFederationProviderModel
 
getPrivateKey() - Method in class org.keycloak.models.KeyManager.ActiveKey
 
getProtocol() - Method in interface org.keycloak.models.ClientModel
 
getProtocol() - Method in interface org.keycloak.models.ClientTemplateModel
 
getProtocol() - Method in class org.keycloak.models.ProtocolMapperModel
 
getProtocolMapper() - Method in class org.keycloak.models.ProtocolMapperModel
 
getProtocolMapperById(String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProtocolMapperByName(String, String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProtocolMappers() - Method in interface org.keycloak.models.ClientSessionModel
 
getProtocolMappers() - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProvider(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
Get dedicated provider instance of provider type clazz that was created for this session.
getProvider(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSession
Get dedicated provider instance for a specific provider factory of id of provider type clazz that was created for this session.
getProvider(Class<T>, ComponentModel) - Method in interface org.keycloak.models.KeycloakSession
 
getProviderClass(String) - Method in interface org.keycloak.models.KeycloakSession
 
getProviderClass() - Method in interface org.keycloak.provider.Spi
 
getProviderClass() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi
 
getProviderClass() - Method in class org.keycloak.storage.UserStorageProviderSpi
 
getProviderFactories(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getProviderFactory(Class<T>) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getProviderFactory(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getProviderFactoryClass() - Method in interface org.keycloak.provider.Spi
 
getProviderFactoryClass() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.storage.UserStorageProviderSpi
 
getProviderId() - Method in class org.keycloak.component.ComponentModel
 
getProviderId() - Method in class org.keycloak.keys.KeyMetadata
 
getProviderId() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getProviderId() - Method in class org.keycloak.models.IdentityProviderModel
 
getProviderId() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getProviderId() - Method in class org.keycloak.storage.StorageId
 
getProviderName() - Method in class org.keycloak.models.UserFederationProviderModel
 
getProviderPriority() - Method in class org.keycloak.keys.KeyMetadata
 
getProviderType() - Method in class org.keycloak.component.ComponentModel
 
getPublicKey() - Method in class org.keycloak.keys.KeyMetadata
 
getPublicKey() - Method in class org.keycloak.models.KeyManager.ActiveKey
 
getPublicKey(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
 
getQuickLoginCheckMilliSeconds() - Method in interface org.keycloak.models.RealmModel
 
getRealm() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getRealm() - Method in interface org.keycloak.models.ClientModel
 
getRealm() - Method in interface org.keycloak.models.ClientSessionModel
 
getRealm() - Method in interface org.keycloak.models.ClientTemplateModel
 
getRealm() - Method in interface org.keycloak.models.KeycloakContext
 
getRealm() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
 
getRealm() - Method in interface org.keycloak.models.RealmModel.UserFederationProviderCreationEvent
 
getRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
getRealm() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
 
getRealm() - Method in interface org.keycloak.models.UserSessionModel
 
getRealmByName(String) - Method in interface org.keycloak.models.RealmProvider
 
getRealmId() - Method in interface org.keycloak.models.ScriptModel
Returns the realm id in which the script was defined.
getRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
getRealmRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel
Returns set of realm roles that are directly set to this object.
getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getRealmRoles(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getRealms() - Method in interface org.keycloak.models.RealmProvider
 
getRealmScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel
 
getRedirectUri() - Method in interface org.keycloak.models.ClientSessionModel
 
getRedirectUris() - Method in interface org.keycloak.models.ClientModel
 
getRegisteredNodes() - Method in interface org.keycloak.models.ClientModel
 
getRegistrationFlow() - Method in interface org.keycloak.models.RealmModel
 
getRegistrationToken() - Method in interface org.keycloak.models.ClientModel
 
getRemainingCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getRemoved() - Method in class org.keycloak.models.UserFederationSyncResult
 
getRemoved() - Method in class org.keycloak.storage.user.SynchronizationResult
 
getRequestHeaders() - Method in interface org.keycloak.models.KeycloakContext
 
getRequiredActionProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getRequiredActionProviderById(String) - Method in interface org.keycloak.models.RealmModel
 
getRequiredActionProviders() - Method in interface org.keycloak.models.RealmModel
 
getRequiredActions() - Method in interface org.keycloak.models.ClientSessionModel
Required actions that are attached to this client session.
getRequiredActions() - Method in interface org.keycloak.models.UserModel
 
getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getRequiredActions(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage
 
getRequiredCredentials() - Method in interface org.keycloak.models.RealmModel
 
getRequirement() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getResetCredentialsFlow() - Method in interface org.keycloak.models.RealmModel
 
getRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
getRole() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
 
getRoleById(String) - Method in interface org.keycloak.models.RealmModel
 
getRoleById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel
Returns set of all role (both realm all client) that are directly set to this object.
getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getRoleMappings(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage
 
getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
getRoles() - Method in interface org.keycloak.models.ClientSessionModel
 
getRoles() - Method in interface org.keycloak.models.RoleContainerModel
 
getRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
 
getRootUrl() - Method in interface org.keycloak.models.ClientModel
 
getSalt() - Method in class org.keycloak.credential.CredentialModel
 
getScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel
 
getSecret() - Method in interface org.keycloak.models.ClientModel
 
getServerStartupTimestamp() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getServiceAccount(ClientModel) - Method in class org.keycloak.models.UserFederationManager
 
getServiceAccount(ClientModel) - Method in interface org.keycloak.models.UserProvider
 
getServiceAccountClientLink() - Method in interface org.keycloak.models.UserModel
 
getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
This method should not be overriden
getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
This method should not be overriden
getSmtpConfig() - Method in interface org.keycloak.models.RealmModel
 
getSpi(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getSpis() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getSslRequired() - Method in interface org.keycloak.models.RealmModel
 
getSsoSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
 
getSsoSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
 
getStarted() - Method in interface org.keycloak.models.UserSessionModel
 
getState() - Method in class org.keycloak.models.CredentialValidationOutput
State that is passed back by provider
getState() - Method in interface org.keycloak.models.UserSessionModel
 
getStatus() - Method in class org.keycloak.keys.KeyMetadata
 
getStatus() - Method in class org.keycloak.models.UserFederationSyncResult
 
getStatus() - Method in class org.keycloak.storage.user.SynchronizationResult
 
getStoredCredentialById(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
 
getStoredCredentialById(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
getStoredCredentialByNameAndType(RealmModel, UserModel, String, String) - Method in interface org.keycloak.credential.UserCredentialStore
 
getStoredCredentialByNameAndType(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
getStoredCredentials(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore
 
getStoredCredentials(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
getStoredCredentialsByType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
 
getStoredCredentialsByType(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
getStoredUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
getStoredUsersCount(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
getStoredVersion() - Method in interface org.keycloak.migration.MigrationModel
 
getSubGroups() - Method in interface org.keycloak.models.GroupModel
 
getSubType() - Method in class org.keycloak.component.ComponentModel
 
getSupportedCredentialTypes() - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
What UserCredentialModel types should be handled by this provider? This is called in scenarios when we don't know user, who is going to authenticate (For example Kerberos authentication).
getSupportedLocales() - Method in interface org.keycloak.models.RealmModel
 
getTimestamp() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getTimestamp() - Method in interface org.keycloak.models.ClientSessionModel
 
getToken() - Method in class org.keycloak.models.FederatedIdentityModel
 
getTopLevelGroups() - Method in interface org.keycloak.models.RealmModel
 
getTopLevelGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getTransactionManager() - Method in interface org.keycloak.models.KeycloakSession
 
getType() - Method in interface org.keycloak.credential.CredentialInput
 
getType() - Method in class org.keycloak.credential.CredentialModel
 
getType() - Method in class org.keycloak.keys.KeyMetadata
 
getType() - Method in class org.keycloak.models.ClaimTypeModel
 
getType() - Method in class org.keycloak.models.OTPPolicy
 
getType() - Method in class org.keycloak.models.RequiredCredentialModel
 
getType() - Method in class org.keycloak.models.UserCredentialModel
 
getType() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getTypeMetadata() - Method in interface org.keycloak.component.ComponentFactory
This is metadata about this component type.
getTypeMetadata(RealmModel, ComponentModel) - Method in interface org.keycloak.component.SubComponentFactory
This is metadata about this component type.
getTypeMetadata() - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
getUpdated() - Method in class org.keycloak.models.UserFederationSyncResult
 
getUpdated() - Method in class org.keycloak.storage.user.SynchronizationResult
 
getUpdatedClient() - Method in interface org.keycloak.models.RealmModel.ClientUpdatedEvent
 
getUri() - Method in interface org.keycloak.models.KeycloakContext
 
getUser() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
 
getUser() - Method in interface org.keycloak.models.UserSessionModel
 
getUserByEmail(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByEmail(RealmModel, String) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Keycloak will search for user in local storage first.
getUserByEmail(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider
 
getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
getUserById(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserById(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider
 
getUserByUsername(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByUsername(RealmModel, String) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Keycloak will search for user in local storage first.
getUserByUsername(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider
 
getUserCache() - Method in interface org.keycloak.models.KeycloakSession
The user cache
getUserFederationMapperById(String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMappers() - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMappersByFederationProvider(String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationProviders() - Method in interface org.keycloak.models.RealmModel
 
getUserId() - Method in class org.keycloak.models.FederatedIdentityModel
 
getUserId() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserName() - Method in class org.keycloak.models.FederatedIdentityModel
 
getUsername() - Method in interface org.keycloak.models.UserModel
 
getUsers(RealmModel, boolean) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel, int, int, boolean) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider
 
getUsers(RealmModel, int, int, boolean) - Method in interface org.keycloak.models.UserProvider
 
getUsers(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
getUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
getUsersByUserAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage
 
getUsersCount(RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUsersCount(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
getUserSession() - Method in interface org.keycloak.models.ClientSessionModel
 
getUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionByBrokerSessionId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionByBrokerUserId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionNotes() - Method in interface org.keycloak.models.ClientSessionModel
These are notes you want applied to the UserSessionModel when the client session is attached to it.
getUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserStorageProviders() - Method in interface org.keycloak.models.RealmModel
 
getValue() - Method in class org.keycloak.credential.CredentialModel
 
getValue() - Method in class org.keycloak.models.UserCredentialModel
 
getWaitIncrementSeconds() - Method in interface org.keycloak.models.RealmModel
 
getWebOrigins() - Method in interface org.keycloak.models.ClientModel
 
grantRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
Grants the given role to this object.
grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
grantRole(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage
 
grantToAllUsers(RealmModel, RoleModel) - Method in class org.keycloak.models.UserFederationManager
 
grantToAllUsers(RealmModel, RoleModel) - Method in interface org.keycloak.storage.user.UserRegistrationProvider
 
GroupModel - Interface in org.keycloak.models
 

H

HASH_ALGORITHM_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy
 
HASH_ALGORITHM_ID - Static variable in class org.keycloak.models.PasswordPolicy
 
HASH_ITERATIONS_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy
 
HASH_ITERATIONS_ID - Static variable in class org.keycloak.models.PasswordPolicy
 
hashCode() - Method in class org.keycloak.models.ClaimTypeModel
 
hashCode() - Method in class org.keycloak.models.FederatedIdentityModel
 
hashCode() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
hashCode() - Method in class org.keycloak.models.ProtocolMapperModel
 
hashCode() - Method in class org.keycloak.models.UserFederationMapperModel
 
hashCode() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
hashCode() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
hasNote(String) - Method in class org.keycloak.component.ComponentModel
 
hasRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
Returns true if this object is directly or indirectly assigned the given role, false otherwise.
hasRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
hasRole(Set<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils
 
hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
hasRoleFromGroup(GroupModel, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils
Checks whether the targetRole is contained in the given group or its parents (if requested)
hasRoleFromGroup(Iterable<GroupModel>, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils
Checks whether the targetRole is contained in any of the groups or their parents (if requested)
hasScope(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
helpText - Variable in class org.keycloak.provider.ProviderConfigProperty
 
helpText(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
HMAC_SHA1 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HMAC_SHA256 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HMAC_SHA512 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HmacOTP - Class in org.keycloak.models.utils
 
HmacOTP(int, String, int) - Constructor for class org.keycloak.models.utils.HmacOTP
 
HOTP - Static variable in class org.keycloak.credential.CredentialModel
 
HOTP - Static variable in class org.keycloak.models.UserCredentialModel
 
hotp(String) - Static method in class org.keycloak.models.UserCredentialModel
 

I

id - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
id - Variable in class org.keycloak.models.ProtocolMapperModel
 
id - Variable in class org.keycloak.models.UserFederationMapperModel
 
identityProviderAlias - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
identityProviderMapper - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
IdentityProviderMapperModel - Class in org.keycloak.models
Specifies a mapping from broker login to user data.
IdentityProviderMapperModel() - Constructor for class org.keycloak.models.IdentityProviderMapperModel
 
IdentityProviderModel - Class in org.keycloak.models
A model type representing the configuration for identity providers.
IdentityProviderModel() - Constructor for class org.keycloak.models.IdentityProviderModel
 
IdentityProviderModel(IdentityProviderModel) - Constructor for class org.keycloak.models.IdentityProviderModel
 
ignored() - Static method in class org.keycloak.models.UserFederationSyncResult
 
ignored() - Static method in class org.keycloak.storage.user.SynchronizationResult
 
importClientSession(ClientSessionModel, boolean) - Method in interface org.keycloak.models.UserSessionProvider
 
importComponentModel(ComponentModel) - Method in interface org.keycloak.models.RealmModel
Adds component model.
ImportedUserValidation - Interface in org.keycloak.storage.user
 
ImportSynchronization - Interface in org.keycloak.storage.user
 
importUserSession(UserSessionModel, boolean) - Method in interface org.keycloak.models.UserSessionProvider
 
increaseAdded() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseAdded() - Method in class org.keycloak.storage.user.SynchronizationResult
 
increaseFailed() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseFailed() - Method in class org.keycloak.storage.user.SynchronizationResult
 
increaseRemoved() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseRemoved() - Method in class org.keycloak.storage.user.SynchronizationResult
 
increaseUpdated() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseUpdated() - Method in class org.keycloak.storage.user.SynchronizationResult
 
incrementFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
init(Config.Scope) - Method in interface org.keycloak.provider.ProviderFactory
Only called once when the factory is first created.
init(Config.Scope) - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
initialCounter - Variable in class org.keycloak.models.OTPPolicy
 
input - Variable in class org.keycloak.models.RequiredCredentialModel
 
INT_CONFIG_TYPE - Static variable in interface org.keycloak.policy.PasswordPolicyProvider
 
invalidate() - Method in interface org.keycloak.models.cache.CachedUserModel
Invalidate the cache for this model
isActive() - Method in interface org.keycloak.models.KeycloakTransaction
 
isAddReadTokenRoleOnCreate() - Method in class org.keycloak.models.IdentityProviderModel
 
isAdminEventsDetailsEnabled() - Method in interface org.keycloak.models.RealmModel
 
isAdminEventsEnabled() - Method in interface org.keycloak.models.RealmModel
 
isAlternative() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isAuthenticateByDefault() - Method in class org.keycloak.models.IdentityProviderModel
Deprecated.
isAuthenticatorFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
Is the referenced authenticator a flow?
isBearerOnly() - Method in interface org.keycloak.models.ClientModel
 
isBearerOnly() - Method in interface org.keycloak.models.ClientTemplateModel
 
isBruteForceProtected() - Method in interface org.keycloak.models.RealmModel
 
isBuiltIn() - Method in class org.keycloak.models.AuthenticationFlowModel
 
isBuiltIn() - Method in class org.keycloak.models.ClaimTypeModel
 
isClientRole() - Method in interface org.keycloak.models.RoleModel
 
isComposite() - Method in interface org.keycloak.models.RoleModel
 
isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputValidator
 
isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
Checks to see if user has credential type configured.
isConfiguredLocally(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
Only loops through each CredentialProvider to see if credential type is configured for the user.
isConsentRequired() - Method in interface org.keycloak.models.ClientModel
 
isConsentRequired() - Method in interface org.keycloak.models.ClientTemplateModel
 
isConsentRequired() - Method in class org.keycloak.models.ProtocolMapperModel
 
isDefaultAction() - Method in class org.keycloak.models.RequiredActionProviderModel
 
isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientModel
 
isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isDisabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isEditUsernameAllowed() - Method in interface org.keycloak.models.RealmModel
 
isEmailVerified() - Method in interface org.keycloak.models.UserModel
 
isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
isEnabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isEnabled() - Method in interface org.keycloak.models.ClientModel
 
isEnabled() - Method in class org.keycloak.models.IdentityProviderModel
 
isEnabled() - Method in interface org.keycloak.models.RealmModel
 
isEnabled() - Method in class org.keycloak.models.RequiredActionProviderModel
 
isEnabled() - Method in interface org.keycloak.models.UserModel
 
isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
isEventsEnabled() - Method in interface org.keycloak.models.RealmModel
 
isFrontchannelLogout() - Method in interface org.keycloak.models.ClientModel
 
isFrontchannelLogout() - Method in interface org.keycloak.models.ClientTemplateModel
 
isFullScopeAllowed() - Method in interface org.keycloak.models.ScopeContainerModel
 
isIdentityFederationEnabled() - Method in interface org.keycloak.models.RealmModel
 
isIgnored() - Method in class org.keycloak.models.UserFederationSyncResult
 
isIgnored() - Method in class org.keycloak.storage.user.SynchronizationResult
 
isImplicitFlowEnabled() - Method in interface org.keycloak.models.ClientModel
 
isImplicitFlowEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isImportEnabled() - Method in class org.keycloak.storage.UserStorageProviderModel
 
isInput() - Method in class org.keycloak.models.RequiredCredentialModel
 
isInternal() - Method in interface org.keycloak.provider.Spi
 
isInternal() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi
 
isInternal() - Method in class org.keycloak.storage.UserStorageProviderSpi
 
isInternationalizationEnabled() - Method in interface org.keycloak.models.RealmModel
 
isLocal() - Method in class org.keycloak.storage.StorageId
 
isLocalStorage(UserModel) - Static method in class org.keycloak.storage.StorageId
 
isLocalStorage(String) - Static method in class org.keycloak.storage.StorageId
 
isMarkedForEviction() - Method in interface org.keycloak.models.cache.CachedUserModel
 
isMember(Set<GroupModel>, GroupModel) - Static method in class org.keycloak.models.utils.RoleUtils
 
isMemberOf(GroupModel) - Method in interface org.keycloak.models.UserModel
 
isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
isOptional() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isOtp(String) - Static method in class org.keycloak.models.UserCredentialModel
 
isProtocolMapperGranted(ProtocolMapperModel) - Method in class org.keycloak.models.UserConsentModel
 
isPublicClient() - Method in interface org.keycloak.models.ClientModel
 
isPublicClient() - Method in interface org.keycloak.models.ClientTemplateModel
 
isRegistrationAllowed() - Method in interface org.keycloak.models.RealmModel
 
isRegistrationEmailAsUsername() - Method in interface org.keycloak.models.RealmModel
 
isRememberMe() - Method in interface org.keycloak.models.RealmModel
 
isRememberMe() - Method in interface org.keycloak.models.UserSessionModel
 
isRequired() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isResetPasswordAllowed() - Method in interface org.keycloak.models.RealmModel
 
isRevokeRefreshToken() - Method in interface org.keycloak.models.RealmModel
 
isRoleGranted(RoleModel) - Method in class org.keycloak.models.UserConsentModel
 
isScopeParamRequired() - Method in interface org.keycloak.models.RoleModel
 
isSecret() - Method in class org.keycloak.models.RequiredCredentialModel
 
isSecret() - Method in class org.keycloak.provider.ProviderConfigProperty
 
isServiceAccountsEnabled() - Method in interface org.keycloak.models.ClientModel
 
isServiceAccountsEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isStandardFlowEnabled() - Method in interface org.keycloak.models.ClientModel
 
isStandardFlowEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isStoreToken() - Method in class org.keycloak.models.IdentityProviderModel
 
isSurrogateAuthRequired() - Method in interface org.keycloak.models.ClientModel
 
isTopLevel() - Method in class org.keycloak.models.AuthenticationFlowModel
 
isTrustEmail() - Method in class org.keycloak.models.IdentityProviderModel
 
isValid(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputValidator
 
isValid(RealmModel, UserModel, List<CredentialInput>) - Method in interface org.keycloak.models.UserCredentialManager
Validates list of credentials.
isValid(RealmModel, UserModel, CredentialInput...) - Method in interface org.keycloak.models.UserCredentialManager
Validates list of credentials.
isValid(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Is the Keycloak UserModel still valid and/or existing in federated storage? Keycloak may call this method in various user operations.
isVerifyEmail() - Method in interface org.keycloak.models.RealmModel
 

J

joinGroup(GroupModel) - Method in interface org.keycloak.models.UserModel
 
joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
joinGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
 

K

KERBEROS - Static variable in class org.keycloak.credential.CredentialModel
 
KERBEROS - Static variable in class org.keycloak.models.RequiredCredentialModel
 
KERBEROS - Static variable in class org.keycloak.models.UserCredentialModel
 
kerberos(String) - Static method in class org.keycloak.models.UserCredentialModel
 
KeycloakContext - Interface in org.keycloak.models
 
keycloakId(ComponentModel, String) - Static method in class org.keycloak.storage.StorageId
generate the id string that should be returned by UserModel.getId()
KeycloakSession - Interface in org.keycloak.models
 
KeycloakSessionFactory - Interface in org.keycloak.models
 
KeycloakSessionTask - Interface in org.keycloak.models
Task to be executed inside transaction
KeycloakTransaction - Interface in org.keycloak.models
 
KeycloakTransactionManager - Interface in org.keycloak.models
 
KeycloakTransactionManager.JTAPolicy - Enum in org.keycloak.models
 
KeyManager - Interface in org.keycloak.models
 
KeyManager.ActiveKey - Class in org.keycloak.models
 
KeyMetadata - Class in org.keycloak.keys
 
KeyMetadata() - Constructor for class org.keycloak.keys.KeyMetadata
 
KeyMetadata.Status - Enum in org.keycloak.keys
 
KeyMetadata.Type - Enum in org.keycloak.keys
 
keys() - Method in interface org.keycloak.models.KeycloakSession
Key manager

L

label - Variable in class org.keycloak.provider.ProviderConfigProperty
 
label(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
LAST_NAME - Static variable in interface org.keycloak.models.UserFederationProvider
Deprecated.
 
LAST_NAME - Static variable in interface org.keycloak.models.UserModel
 
LAST_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
leaveGroup(GroupModel) - Method in interface org.keycloak.models.UserModel
 
leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
leaveGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
 
LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
listClientInitialAccess(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
listProviderIds(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
Get all provider factories that manage provider instances of class.
LOCALE - Static variable in interface org.keycloak.models.UserModel
 
logger - Static variable in class org.keycloak.models.OTPPolicy
 
lookAheadWindow - Variable in class org.keycloak.models.OTPPolicy
 
lookAheadWindow - Variable in class org.keycloak.models.utils.HmacOTP
 

M

merge(CredentialValidationOutput) - Method in class org.keycloak.models.CredentialValidationOutput
 
MigrationModel - Interface in org.keycloak.migration
 
moveGroup(GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmModel
 
moveGroup(RealmModel, GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
MULTIVALUED_LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
MULTIVALUED_STRING_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 

N

name - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
name - Variable in class org.keycloak.models.ProtocolMapperModel
 
name - Variable in class org.keycloak.models.UserFederationMapperModel
 
name - Variable in class org.keycloak.provider.ProviderConfigProperty
 
name(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
numberDigits - Variable in class org.keycloak.models.utils.HmacOTP
 

O

onCache(RealmModel, CachedUserModel, UserModel) - Method in interface org.keycloak.models.cache.OnUserCache
 
onClientRemoved(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
 
onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory
Called when UserStorageProviderModel is created.
onEvent(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventListener
 
onRealmRemoved(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
OnUserCache - Interface in org.keycloak.models.cache
 
options - Variable in class org.keycloak.provider.ProviderConfigProperty
 
options(String...) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
options(List<String>) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
org.keycloak.component - package org.keycloak.component
 
org.keycloak.credential - package org.keycloak.credential
 
org.keycloak.credential.hash - package org.keycloak.credential.hash
 
org.keycloak.keys - package org.keycloak.keys
 
org.keycloak.migration - package org.keycloak.migration
 
org.keycloak.models - package org.keycloak.models
 
org.keycloak.models.cache - package org.keycloak.models.cache
 
org.keycloak.models.utils - package org.keycloak.models.utils
 
org.keycloak.policy - package org.keycloak.policy
 
org.keycloak.provider - package org.keycloak.provider
 
org.keycloak.storage - package org.keycloak.storage
 
org.keycloak.storage.adapter - package org.keycloak.storage.adapter
 
org.keycloak.storage.federated - package org.keycloak.storage.federated
 
org.keycloak.storage.user - package org.keycloak.storage.user
 
OTP - Static variable in class org.keycloak.credential.CredentialModel
 
otp(String, String) - Static method in class org.keycloak.models.UserCredentialModel
 
OTPPolicy - Class in org.keycloak.models
 
OTPPolicy() - Constructor for class org.keycloak.models.OTPPolicy
 
OTPPolicy(String, String, int, int, int, int) - Constructor for class org.keycloak.models.OTPPolicy
 

P

parse(KeycloakSession, String) - Static method in class org.keycloak.models.PasswordPolicy
 
parseConfig(String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
 
parsePriority(ComponentModel) - Static method in class org.keycloak.component.PrioritizedComponentModel
 
PASSWORD - Static variable in class org.keycloak.credential.CredentialModel
 
PASSWORD - Static variable in class org.keycloak.models.RequiredCredentialModel
 
PASSWORD - Static variable in class org.keycloak.models.UserCredentialModel
 
password(String) - Static method in class org.keycloak.models.UserCredentialModel
 
PASSWORD - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
PASSWORD_HISTORY - Static variable in class org.keycloak.credential.CredentialModel
 
PASSWORD_HISTORY - Static variable in class org.keycloak.models.UserCredentialModel
 
PASSWORD_HISTORY_ID - Static variable in class org.keycloak.models.PasswordPolicy
 
PASSWORD_TOKEN - Static variable in class org.keycloak.credential.CredentialModel
 
PASSWORD_TOKEN - Static variable in class org.keycloak.models.UserCredentialModel
 
PasswordHashProvider - Interface in org.keycloak.credential.hash
 
PasswordPolicy - Class in org.keycloak.models
 
PasswordPolicyProvider - Interface in org.keycloak.policy
 
passwordToken(String) - Static method in class org.keycloak.models.UserCredentialModel
 
period - Variable in class org.keycloak.models.OTPPolicy
 
policyCheck(PasswordPolicy, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
 
PolicyError - Class in org.keycloak.policy
 
PolicyError(String, Object...) - Constructor for class org.keycloak.policy.PolicyError
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.provider.ProviderFactory
Called after all provider factories have been initialized
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
preRemove(RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, UserFederationProviderModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, GroupModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, RoleModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, ClientModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(ProtocolMapperModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, ComponentModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
called whenever a Realm is removed
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
called before a role is removed.
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
called before a role is removed.
preRemove(RealmModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, UserFederationProviderModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(ProtocolMapperModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, UserFederationProviderModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(ProtocolMapperModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, UserModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider
 
preRemove(RealmModel) - Method in interface org.keycloak.storage.UserStorageProvider
 
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.UserStorageProvider
 
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.UserStorageProvider
 
PrioritizedComponentModel - Class in org.keycloak.component
 
PrioritizedComponentModel(ComponentModel) - Constructor for class org.keycloak.component.PrioritizedComponentModel
 
PrioritizedComponentModel() - Constructor for class org.keycloak.component.PrioritizedComponentModel
 
PRIVATE_KEY - Static variable in interface org.keycloak.models.ClientModel
 
property() - Method in class org.keycloak.provider.ProviderConfigurationBuilder
 
property(ProviderConfigProperty) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
 
property(String, String, String, String, Object, List<String>, boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
 
property(String, String, String, String, Object, List<String>) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
 
protocol - Variable in class org.keycloak.models.ProtocolMapperModel
 
protocolMapper - Variable in class org.keycloak.models.ProtocolMapperModel
 
ProtocolMapperContainerModel - Interface in org.keycloak.models
 
ProtocolMapperModel - Class in org.keycloak.models
Specifies a mapping from user data to a protocol claim assertion.
ProtocolMapperModel() - Constructor for class org.keycloak.models.ProtocolMapperModel
 
Provider - Interface in org.keycloak.provider
 
ProviderConfigProperty - Class in org.keycloak.provider
 
ProviderConfigProperty() - Constructor for class org.keycloak.provider.ProviderConfigProperty
 
ProviderConfigProperty(String, String, String, String, Object) - Constructor for class org.keycloak.provider.ProviderConfigProperty
 
ProviderConfigProperty(String, String, String, String, Object, String...) - Constructor for class org.keycloak.provider.ProviderConfigProperty
 
ProviderConfigProperty(String, String, String, String, Object, boolean) - Constructor for class org.keycloak.provider.ProviderConfigProperty
 
ProviderConfigPropertyBuilder() - Constructor for class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
ProviderConfigurationBuilder - Class in org.keycloak.provider
 
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder - Class in org.keycloak.provider
 
ProviderEvent - Interface in org.keycloak.provider
 
ProviderEventListener - Interface in org.keycloak.provider
 
ProviderEventManager - Interface in org.keycloak.provider
 
ProviderFactory<T extends Provider> - Interface in org.keycloak.provider
At boot time, keycloak discovers all factories.
providerId(String) - Static method in class org.keycloak.storage.StorageId
 
PUBLIC_KEY - Static variable in interface org.keycloak.models.ClientModel
 
publish(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventManager
 
put(String, String) - Method in class org.keycloak.component.ComponentModel
 
put(String, int) - Method in class org.keycloak.component.ComponentModel
 
put(String, long) - Method in class org.keycloak.component.ComponentModel
 
put(String, boolean) - Method in class org.keycloak.component.ComponentModel
 

Q

query(UserFederationManager.PaginatedQuery, RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 

R

ReadOnlyException(String) - Constructor for exception org.keycloak.storage.adapter.AbstractUserAdapter.ReadOnlyException
 
realm - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter
 
realm - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
RealmModel - Interface in org.keycloak.models
 
RealmModel.ClientCreationEvent - Interface in org.keycloak.models
 
RealmModel.ClientRemovedEvent - Interface in org.keycloak.models
 
RealmModel.ClientUpdatedEvent - Interface in org.keycloak.models
 
RealmModel.RealmCreationEvent - Interface in org.keycloak.models
 
RealmModel.RealmPostCreateEvent - Interface in org.keycloak.models
 
RealmModel.RealmRemovedEvent - Interface in org.keycloak.models
 
RealmModel.UserFederationProviderCreationEvent - Interface in org.keycloak.models
 
RealmProvider - Interface in org.keycloak.models
 
realms() - Method in interface org.keycloak.models.KeycloakSession
Returns a managed provider instance.
register(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Called if this federation provider has priority and supports synchronized registrations.
register(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
 
registerNode(String, int) - Method in interface org.keycloak.models.ClientModel
Register node or just update the 'lastReRegistration' time if this node is already registered
registerWithFederation(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
removeAllUserLoginFailures(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeAttribute(String) - Method in interface org.keycloak.models.ClientModel
 
removeAttribute(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
removeAttribute(String) - Method in interface org.keycloak.models.GroupModel
 
removeAttribute(String) - Method in interface org.keycloak.models.KeycloakSession
 
removeAttribute(String) - Method in interface org.keycloak.models.RealmModel
 
removeAttribute(String) - Method in interface org.keycloak.models.UserModel
 
removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
removeAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage
 
removeAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
removeAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
removeAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
removeChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
Automatically calls setParent() on the subGroup
removeClient(String) - Method in interface org.keycloak.models.RealmModel
 
removeClient(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
removeClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeClientSession(RealmModel, ClientSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeClientTemplate(String) - Method in interface org.keycloak.models.RealmModel
 
removeComponent(ComponentModel) - Method in interface org.keycloak.models.RealmModel
 
removeComponents(String) - Method in interface org.keycloak.models.RealmModel
 
removeCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
removeDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
removeDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
 
removeExpired(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeFederatedIdentity(RealmModel, UserModel, String) - Method in class org.keycloak.models.UserFederationManager
 
removeFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider
 
removeFederatedIdentity(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
removeGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
removeGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
removeIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
removeIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
removeNote(String) - Method in interface org.keycloak.models.ClientSessionModel
 
removeNote(String) - Method in interface org.keycloak.models.UserSessionModel
 
removeOfflineClientSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeOfflineUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
removeRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
removeRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
 
removeRequiredAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.ClientSessionModel
 
removeRequiredAction(String) - Method in interface org.keycloak.models.UserModel
 
removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
 
removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
removeRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage
 
removeRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
removeRole(RealmModel, RoleModel) - Method in interface org.keycloak.models.RealmProvider
 
removeRole(RoleModel) - Method in interface org.keycloak.models.RoleContainerModel
 
removeStoredCredential(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
 
removeStoredCredential(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
removeUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
removeUser(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
 
removeUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserManager
 
removeUser(RealmModel, UserModel, UserProvider) - Method in class org.keycloak.models.UserManager
 
removeUser(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.UserRegistrationProvider
 
removeUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
removeUserFederationProvider(UserFederationProviderModel) - Method in interface org.keycloak.models.RealmModel
 
removeUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSessions(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
 
RequiredActionProviderModel - Class in org.keycloak.models
 
RequiredActionProviderModel() - Constructor for class org.keycloak.models.RequiredActionProviderModel
 
RequiredCredentialModel - Class in org.keycloak.models
 
RequiredCredentialModel() - Constructor for class org.keycloak.models.RequiredCredentialModel
 
resolveLocale(UserModel) - Method in interface org.keycloak.models.KeycloakContext
 
resolveProviderId(UserModel) - Static method in class org.keycloak.storage.StorageId
 
revokeConsentForClient(RealmModel, String, String) - Method in class org.keycloak.models.UserFederationManager
 
revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.models.UserProvider
 
revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage
 
ROLE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
RoleContainerModel - Interface in org.keycloak.models
 
RoleContainerModel.RoleRemovedEvent - Interface in org.keycloak.models
 
RoleMapperModel - Interface in org.keycloak.models
 
RoleModel - Interface in org.keycloak.models
 
RoleUtils - Class in org.keycloak.models.utils
 
RoleUtils() - Constructor for class org.keycloak.models.utils.RoleUtils
 
rollback() - Method in interface org.keycloak.models.KeycloakTransaction
 
run(KeycloakSession) - Method in interface org.keycloak.models.KeycloakSessionTask
 

S

ScopeContainerModel - Interface in org.keycloak.models
 
SCRIPT_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
ScriptModel - Interface in org.keycloak.models
A representation of a Script with some additional meta-data.
searchByAttributes(Map<String, String>, RealmModel, int) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Keycloak does not search in local storage first before calling this method.
searchForUser(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(String, RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(Map<String, String>, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(Map<String, String>, RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
Search for users with username, email or first + last name that is like search string.
searchForUser(String, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider
Search for users with username, email or first + last name that is like search string.
searchForUser(Map<String, String>, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
Search for user by parameter.
searchForUser(Map<String, String>, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider
Search for user by parameter.
searchForUserByUserAttribute(String, String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUserByUserAttribute(String, String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
 
SECRET - Static variable in class org.keycloak.credential.CredentialModel
 
secret - Variable in class org.keycloak.models.RequiredCredentialModel
 
SECRET - Static variable in class org.keycloak.models.RequiredCredentialModel
 
SECRET - Static variable in class org.keycloak.models.UserCredentialModel
 
secret(String) - Static method in class org.keycloak.models.UserCredentialModel
 
secret - Variable in class org.keycloak.provider.ProviderConfigProperty
 
secret(boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 
session - Variable in class org.keycloak.models.UserFederationManager
 
session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter
 
session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
sessions() - Method in interface org.keycloak.models.KeycloakSession
Returns a managed provider instance.
setAccessCodeLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessCodeLifespanLogin(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessCodeLifespanUserAction(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessTokenLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessTokenLifespanForImplicitFlow(int) - Method in interface org.keycloak.models.RealmModel
 
setAccountTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
setAdded(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setAdded(int) - Method in class org.keycloak.storage.user.SynchronizationResult
 
setAddReadTokenRoleOnCreate(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setAdminEventsDetailsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setAdminEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setAdminTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setAlgorithm(String) - Method in class org.keycloak.credential.CredentialModel
 
setAlgorithm(String) - Method in class org.keycloak.models.OTPPolicy
 
setAlgorithm(String) - Method in class org.keycloak.models.UserCredentialModel
 
setAlias(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setAlias(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setAlias(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setAlias(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setAttribute(String, String) - Method in interface org.keycloak.models.ClientModel
 
setAttribute(String, String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setAttribute(String, List<String>) - Method in interface org.keycloak.models.GroupModel
 
setAttribute(String, Object) - Method in interface org.keycloak.models.KeycloakSession
 
setAttribute(String, String) - Method in interface org.keycloak.models.RealmModel
 
setAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel
 
setAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel
 
setAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel
 
setAttribute(String, List<String>) - Method in interface org.keycloak.models.UserModel
 
setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setAttribute(RealmModel, String, String, List<String>) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage
 
setAuthenticateByDefault(boolean) - Method in class org.keycloak.models.IdentityProviderModel
Deprecated.
setAuthenticatedUser(UserModel) - Method in interface org.keycloak.models.ClientSessionModel
 
setAuthenticator(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthenticatorConfig(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthenticatorFlow(boolean) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthMethod(String) - Method in interface org.keycloak.models.ClientSessionModel
 
setBaseUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setBearerOnly(boolean) - Method in interface org.keycloak.models.ClientModel
 
setBearerOnly(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setBrowserFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setBrowserSecurityHeaders(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
 
setBruteForceProtected(boolean) - Method in interface org.keycloak.models.RealmModel
 
setBuiltIn(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setBuiltIn(boolean) - Method in class org.keycloak.models.ClaimTypeModel
 
setCacheInvalidBefore(long) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setCachePolicy(UserStorageProviderModel.CachePolicy) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setCertificate(Certificate) - Method in class org.keycloak.keys.KeyMetadata
 
setChangedSyncPeriod(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setChangedSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setClient(ClientModel) - Method in interface org.keycloak.models.KeycloakContext
 
setClientAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setClientAuthenticatorType(String) - Method in interface org.keycloak.models.ClientModel
 
setClientId(String) - Method in interface org.keycloak.models.ClientModel
 
setClientTemplate(ClientTemplateModel) - Method in interface org.keycloak.models.ClientModel
 
setConfig(MultivaluedHashMap<String, String>) - Method in class org.keycloak.component.ComponentModel
 
setConfig(MultivaluedHashMap<String, String>) - Method in class org.keycloak.credential.CredentialModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.ProtocolMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.UserFederationMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.UserFederationProviderModel
 
setConnection(ClientConnection) - Method in interface org.keycloak.models.KeycloakContext
 
setConsentRequired(boolean) - Method in interface org.keycloak.models.ClientModel
 
setConsentRequired(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setConsentRequired(boolean) - Method in class org.keycloak.models.ProtocolMapperModel
 
setConsentText(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setCounter(int) - Method in class org.keycloak.credential.CredentialModel
 
setCreatedDate(Long) - Method in class org.keycloak.credential.CredentialModel
 
setCreatedDate(Long) - Method in class org.keycloak.models.UserConsentModel
 
setCreatedTimestamp(Long) - Method in interface org.keycloak.models.UserModel
 
setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setDefaultAction(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setDefaultLocale(String) - Method in interface org.keycloak.models.RealmModel
 
setDefaultValue(Object) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setDescription(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setDescription(String) - Method in interface org.keycloak.models.ClientModel
 
setDescription(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setDescription(String) - Method in interface org.keycloak.models.RoleModel
 
setDevice(String) - Method in class org.keycloak.credential.CredentialModel
 
setDevice(String) - Method in class org.keycloak.models.UserCredentialModel
 
setDigits(int) - Method in class org.keycloak.credential.CredentialModel
 
setDigits(int) - Method in class org.keycloak.models.OTPPolicy
 
setDirectAccessGrantsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setDirectAccessGrantsEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setDirectGrantFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setDisplayName(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setDisplayName(String) - Method in interface org.keycloak.models.RealmModel
 
setDisplayName(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setDisplayNameHtml(String) - Method in interface org.keycloak.models.RealmModel
 
setEditUsernameAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEmail(String) - Method in interface org.keycloak.models.UserModel
 
setEmail(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setEmail(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setEmailTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setEmailVerified(boolean) - Method in interface org.keycloak.models.UserModel
 
setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setEnabled(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEnabled(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setEnabled(boolean) - Method in interface org.keycloak.models.UserModel
 
setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setEnabledEventTypes(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
setEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEventsExpiration(long) - Method in interface org.keycloak.models.RealmModel
 
setEventsListeners(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
setEvictionDay(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setEvictionHour(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setEvictionMinute(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setExecutionStatus(String, ClientSessionModel.ExecutionStatus) - Method in interface org.keycloak.models.ClientSessionModel
 
setFailed(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setFailed(int) - Method in class org.keycloak.storage.user.SynchronizationResult
 
setFailedLoginNotBefore(int) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setFailureFactor(int) - Method in interface org.keycloak.models.RealmModel
 
setFederationLink(String) - Method in interface org.keycloak.models.UserModel
 
setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
This method should not be overriden
setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
This method should not be overriden
setFederationMapperType(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setFederationProviderId(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setFirstBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setFirstName(String) - Method in interface org.keycloak.models.UserModel
 
setFirstName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setFirstName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setFlowId(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setFormLabel(String) - Method in class org.keycloak.models.RequiredCredentialModel
 
setFrontchannelLogout(boolean) - Method in interface org.keycloak.models.ClientModel
 
setFrontchannelLogout(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setFullScopeAllowed(boolean) - Method in interface org.keycloak.models.ScopeContainerModel
 
setFullSyncPeriod(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setFullSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setHashIterations(int) - Method in class org.keycloak.credential.CredentialModel
 
setHelpText(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setId(String) - Method in class org.keycloak.component.ComponentModel
 
setId(String) - Method in class org.keycloak.credential.CredentialModel
 
setId(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setId(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setId(String) - Method in class org.keycloak.models.ClaimTypeModel
 
setId(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setId(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setId(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setId(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setIdentityProviderAlias(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setIdentityProviderMapper(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setIgnored(boolean) - Method in class org.keycloak.models.UserFederationSyncResult
 
setIgnored(boolean) - Method in class org.keycloak.storage.user.SynchronizationResult
 
setImplicitFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setImplicitFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setImportEnabled(boolean) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setInitialCounter(int) - Method in class org.keycloak.models.OTPPolicy
 
setInput(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
 
setInternalId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setInternationalizationEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setJTAPolicy(KeycloakTransactionManager.JTAPolicy) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
setKid(String) - Method in class org.keycloak.keys.KeyMetadata
 
setLabel(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setLastFailure(long) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setLastIPFailure(String) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setLastName(String) - Method in interface org.keycloak.models.UserModel
 
setLastName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setLastName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setLastSessionRefresh(int) - Method in interface org.keycloak.models.UserSessionModel
 
setLastSync(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setLastSync(int) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setLastUpdatedDate(Long) - Method in class org.keycloak.models.UserConsentModel
 
setLoginTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setLookAheadWindow(int) - Method in class org.keycloak.models.OTPPolicy
 
setManagementUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setMasterAdminClient(ClientModel) - Method in interface org.keycloak.models.RealmModel
 
setMaxDeltaTimeSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setMaxFailureWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setMaxLifespan(long) - Method in class org.keycloak.storage.UserStorageProviderModel
 
setMinimumQuickLoginWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setName(String) - Method in class org.keycloak.component.ComponentModel
 
setName(String) - Method in class org.keycloak.models.ClaimTypeModel
 
setName(String) - Method in interface org.keycloak.models.ClientModel
 
setName(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setName(String) - Method in interface org.keycloak.models.GroupModel
 
setName(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setName(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setName(String) - Method in interface org.keycloak.models.RealmModel
 
setName(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setName(String) - Method in interface org.keycloak.models.RoleModel
 
setName(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setName(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setNodeReRegistrationTimeout(int) - Method in interface org.keycloak.models.ClientModel
 
setNotBefore(int) - Method in interface org.keycloak.models.ClientModel
 
setNotBefore(int) - Method in interface org.keycloak.models.RealmModel
 
setNote(String, Object) - Method in class org.keycloak.component.ComponentModel
 
setNote(String, String) - Method in interface org.keycloak.models.ClientSessionModel
 
setNote(String, String) - Method in interface org.keycloak.models.UserSessionModel
 
setOfflineSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
 
setOptions(List<String>) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setOTPPolicy(OTPPolicy) - Method in interface org.keycloak.models.RealmModel
 
setParameters(Object[]) - Method in exception org.keycloak.component.ComponentValidationException
 
setParent(GroupModel) - Method in interface org.keycloak.models.GroupModel
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group
setParentFlow(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setParentId(String) - Method in class org.keycloak.component.ComponentModel
 
setPasswordPolicy(PasswordPolicy) - Method in interface org.keycloak.models.RealmModel
 
setPeriod(int) - Method in class org.keycloak.credential.CredentialModel
 
setPeriod(int) - Method in class org.keycloak.models.OTPPolicy
 
setPostBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setPriority(int) - Method in class org.keycloak.component.PrioritizedComponentModel
 
setPriority(int) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setPriority(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setProtocol(String) - Method in interface org.keycloak.models.ClientModel
 
setProtocol(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setProtocol(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setProtocolMapper(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setProtocolMappers(Set<String>) - Method in interface org.keycloak.models.ClientSessionModel
 
setProviderId(String) - Method in class org.keycloak.component.ComponentModel
 
setProviderId(String) - Method in class org.keycloak.keys.KeyMetadata
 
setProviderId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setProviderId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setProviderId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setProviderName(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setProviderPriority(long) - Method in class org.keycloak.keys.KeyMetadata
 
setProviderType(String) - Method in class org.keycloak.component.ComponentModel
 
setPublicClient(boolean) - Method in interface org.keycloak.models.ClientModel
 
setPublicClient(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setPublicKey(PublicKey) - Method in class org.keycloak.keys.KeyMetadata
 
setQuickLoginCheckMilliSeconds(long) - Method in interface org.keycloak.models.RealmModel
 
setRealm(RealmModel) - Method in interface org.keycloak.models.KeycloakContext
 
setRedirectUri(String) - Method in interface org.keycloak.models.ClientSessionModel
 
setRedirectUris(Set<String>) - Method in interface org.keycloak.models.ClientModel
 
setRegistrationAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationEmailAsUsername(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationToken(String) - Method in interface org.keycloak.models.ClientModel
 
setRememberMe(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRemoved(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setRemoved(int) - Method in class org.keycloak.storage.user.SynchronizationResult
 
setRequirement(AuthenticationExecutionModel.Requirement) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setResetCredentialsFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setResetPasswordAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRevokeRefreshToken(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRoles(Set<String>) - Method in interface org.keycloak.models.ClientSessionModel
 
setRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
 
setRootUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setSalt(byte[]) - Method in class org.keycloak.credential.CredentialModel
 
setScopeParamRequired(boolean) - Method in interface org.keycloak.models.RoleModel
 
setSecret(String) - Method in interface org.keycloak.models.ClientModel
 
setSecret(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
 
setSecret(boolean) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setServiceAccountClientLink(String) - Method in interface org.keycloak.models.UserModel
 
setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
This method should not be overriden
setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
This method should not be overriden
setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setSingleAttribute(String, String) - Method in interface org.keycloak.models.GroupModel
Set single value of specified attribute.
setSingleAttribute(String, String) - Method in interface org.keycloak.models.UserModel
Set single value of specified attribute.
setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
setSingleAttribute(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage
 
setSmtpConfig(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
 
setSslRequired(SslRequired) - Method in interface org.keycloak.models.RealmModel
 
setSsoSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
 
setSsoSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setStandardFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setStandardFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setState(UserSessionModel.State) - Method in interface org.keycloak.models.UserSessionModel
 
setStatus(KeyMetadata.Status) - Method in class org.keycloak.keys.KeyMetadata
 
setStoredVersion(String) - Method in interface org.keycloak.migration.MigrationModel
 
setStoreToken(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setSubType(String) - Method in class org.keycloak.component.ComponentModel
 
setSupportedLocales(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
setSurrogateAuthRequired(boolean) - Method in interface org.keycloak.models.ClientModel
 
setTimestamp(int) - Method in interface org.keycloak.models.ClientSessionModel
 
setToken(String) - Method in class org.keycloak.models.FederatedIdentityModel
 
setTopLevel(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setTrustEmail(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setType(String) - Method in class org.keycloak.credential.CredentialModel
 
setType(KeyMetadata.Type) - Method in class org.keycloak.keys.KeyMetadata
 
setType(ClaimTypeModel.ValueType) - Method in class org.keycloak.models.ClaimTypeModel
 
setType(String) - Method in class org.keycloak.models.OTPPolicy
 
setType(String) - Method in class org.keycloak.models.RequiredCredentialModel
 
setType(String) - Method in class org.keycloak.models.UserCredentialModel
 
setType(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setUpdated(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setUpdated(int) - Method in class org.keycloak.storage.user.SynchronizationResult
 
setUserFederationProviders(List<UserFederationProviderModel>) - Method in interface org.keycloak.models.RealmModel
 
setUsername(String) - Method in interface org.keycloak.models.UserModel
 
setUsername(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter
 
setUserSession(UserSessionModel) - Method in interface org.keycloak.models.ClientSessionModel
 
setUserSessionNote(String, String) - Method in interface org.keycloak.models.ClientSessionModel
These are notes you want applied to the UserSessionModel when the client session is attached to it.
setUseTemplateConfig(boolean) - Method in interface org.keycloak.models.ClientModel
 
setUseTemplateMappers(boolean) - Method in interface org.keycloak.models.ClientModel
 
setUseTemplateScope(boolean) - Method in interface org.keycloak.models.ClientModel
 
setValue(String) - Method in class org.keycloak.credential.CredentialModel
 
setValue(String) - Method in class org.keycloak.models.UserCredentialModel
 
setVerifyEmail(boolean) - Method in interface org.keycloak.models.RealmModel
 
setWaitIncrementSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setWebOrigins(Set<String>) - Method in interface org.keycloak.models.ClientModel
 
SINGLETON - Static variable in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
Spi - Interface in org.keycloak.provider
 
storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter
 
storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
StorageId - Class in org.keycloak.storage
 
StorageId(String) - Constructor for class org.keycloak.storage.StorageId
 
StorageId(String, String) - Constructor for class org.keycloak.storage.StorageId
 
storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter
 
storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage
 
STRING_CONFIG_TYPE - Static variable in interface org.keycloak.policy.PasswordPolicyProvider
 
STRING_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
SubComponentFactory<CreatedType,ProviderType extends Provider> - Interface in org.keycloak.component
Useful when you want to describe config properties that are effected by the parent ComponentModel
supportsCredentialAuthenticationFor(String) - Method in interface org.keycloak.credential.CredentialAuthentication
 
supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputUpdater
 
supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputValidator
 
sync(KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization
 
syncAllUsers(KeycloakSessionFactory, String, UserFederationProviderModel) - Method in interface org.keycloak.models.UserFederationProviderFactory
Sync all users from the provider storage to Keycloak storage.
syncChangedUsers(KeycloakSessionFactory, String, UserFederationProviderModel, Date) - Method in interface org.keycloak.models.UserFederationProviderFactory
Sync just changed (added / updated / removed) users from the provider storage to Keycloak storage.
SynchronizationResult - Class in org.keycloak.storage.user
 
SynchronizationResult() - Constructor for class org.keycloak.storage.user.SynchronizationResult
 
synchronizeRegistrations() - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Should user registrations be synchronized with this provider? FYI, only one provider will be chosen (by priority) to have this synchronization
syncSince(Date, KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization
 

T

TEXT_JAVASCRIPT - Static variable in interface org.keycloak.models.ScriptModel
MIME-Type for JavaScript
toString() - Method in class org.keycloak.models.PasswordPolicy
 
toString() - Method in class org.keycloak.models.UserFederationMapperModel
 
toString() - Method in class org.keycloak.models.UserFederationSyncResult
 
toString() - Method in class org.keycloak.storage.user.SynchronizationResult
 
TOTP - Static variable in class org.keycloak.credential.CredentialModel
 
TOTP - Static variable in class org.keycloak.models.RequiredCredentialModel
 
TOTP - Static variable in class org.keycloak.models.UserCredentialModel
 
totp(String) - Static method in class org.keycloak.models.UserCredentialModel
 
type - Variable in class org.keycloak.models.OTPPolicy
 
type - Variable in class org.keycloak.models.RequiredCredentialModel
 
type - Variable in class org.keycloak.models.UserCredentialModel
 
type - Variable in class org.keycloak.provider.ProviderConfigProperty
 
type(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
 

U

unregister(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
 
unregisterNode(String) - Method in interface org.keycloak.models.ClientModel
 
updateAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
updateAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
updateAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
updateClient() - Method in interface org.keycloak.models.ClientModel
 
updateComponent(ComponentModel) - Method in interface org.keycloak.models.RealmModel
 
updateConsent(RealmModel, String, UserConsentModel) - Method in class org.keycloak.models.UserFederationManager
 
updateConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.models.UserProvider
 
updateConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage
 
updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputUpdater
 
updateCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore
 
updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager
Updates a credential.
updateCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
 
updateDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
 
updateFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in class org.keycloak.models.UserFederationManager
 
updateFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
 
updateFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
 
updateIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
 
updateIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
updateProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
updateRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
updateRequiredCredentials(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
updateUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
updateUserFederationProvider(UserFederationProviderModel) - Method in interface org.keycloak.models.RealmModel
 
UserAttributeFederatedStorage - Interface in org.keycloak.storage.federated
 
UserBrokerLinkFederatedStorage - Interface in org.keycloak.storage.federated
 
UserCache - Interface in org.keycloak.models.cache
 
UserConsentFederatedStorage - Interface in org.keycloak.storage.federated
 
UserConsentModel - Class in org.keycloak.models
 
UserConsentModel(ClientModel) - Constructor for class org.keycloak.models.UserConsentModel
 
userCredentialManager() - Method in interface org.keycloak.models.KeycloakSession
 
UserCredentialManager - Interface in org.keycloak.models
 
UserCredentialModel - Class in org.keycloak.models
 
UserCredentialModel() - Constructor for class org.keycloak.models.UserCredentialModel
 
UserCredentialStore - Interface in org.keycloak.credential
 
userFederatedStorage() - Method in interface org.keycloak.models.KeycloakSession
Hybrid storage for UserStorageProviders that can't store a specific piece of keycloak data in their external storage.
UserFederatedStorageProvider - Interface in org.keycloak.storage.federated
 
UserFederatedStorageProviderFactory - Interface in org.keycloak.storage.federated
 
UserFederatedStorageProviderSpi - Class in org.keycloak.storage.federated
 
UserFederatedStorageProviderSpi() - Constructor for class org.keycloak.storage.federated.UserFederatedStorageProviderSpi
 
UserFederatedUserCredentialStore - Interface in org.keycloak.storage.federated
 
UserFederationManager - Class in org.keycloak.models
 
UserFederationManager(KeycloakSession) - Constructor for class org.keycloak.models.UserFederationManager
 
UserFederationMapperModel - Class in org.keycloak.models
 
UserFederationMapperModel() - Constructor for class org.keycloak.models.UserFederationMapperModel
 
UserFederationProvider - Interface in org.keycloak.models
Deprecated.
UserFederationProvider.EditMode - Enum in org.keycloak.models
Deprecated.
Optional type that can be by implementations to describe edit mode of federation storage
UserFederationProviderFactory - Interface in org.keycloak.models
 
UserFederationProviderModel - Class in org.keycloak.models
Stored configuration of a User Federation provider instance.
UserFederationProviderModel() - Constructor for class org.keycloak.models.UserFederationProviderModel
 
UserFederationProviderModel(String, String, Map<String, String>, int, String, int, int, int) - Constructor for class org.keycloak.models.UserFederationProviderModel
 
UserFederationSyncResult - Class in org.keycloak.models
 
UserFederationSyncResult() - Constructor for class org.keycloak.models.UserFederationSyncResult
 
UserGroupMembershipFederatedStorage - Interface in org.keycloak.storage.federated
 
userLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
Keycloak specific local storage for users.
UserLoginFailureModel - Interface in org.keycloak.models
 
UserLookupProvider - Interface in org.keycloak.storage.user
 
UserManager - Class in org.keycloak.models
 
UserManager(KeycloakSession) - Constructor for class org.keycloak.models.UserManager
 
UserModel - Interface in org.keycloak.models
 
UserModel.RequiredAction - Enum in org.keycloak.models
 
UserModel.UserRemovedEvent - Interface in org.keycloak.models
 
USERNAME - Static variable in interface org.keycloak.models.UserFederationProvider
Deprecated.
 
USERNAME - Static variable in interface org.keycloak.models.UserModel
 
UserProvider - Interface in org.keycloak.models
 
UserQueryProvider - Interface in org.keycloak.storage.user
 
UserRegistrationProvider - Interface in org.keycloak.storage.user
 
UserRequiredActionsFederatedStorage - Interface in org.keycloak.storage.federated
 
UserRoleMappingsFederatedStorage - Interface in org.keycloak.storage.federated
 
users() - Method in interface org.keycloak.models.KeycloakSession
A cached view of all users in system including deprecated UserFederationProvider SPI
UserSessionModel - Interface in org.keycloak.models
 
UserSessionModel.State - Enum in org.keycloak.models
 
UserSessionProvider - Interface in org.keycloak.models
 
userStorage() - Method in interface org.keycloak.models.KeycloakSession
A cached view of all users in system that does NOT include users available from the deprecated UserFederationProvider SPI.
userStorageManager() - Method in interface org.keycloak.models.KeycloakSession
Un-cached view of all users in system that does NOT include users available from the deprecated UserFederationProvider SPI.
UserStorageProvider - Interface in org.keycloak.storage
 
UserStorageProviderFactory<T extends UserStorageProvider> - Interface in org.keycloak.storage
 
UserStorageProviderModel - Class in org.keycloak.storage
Stored configuration of a User Storage provider instance.
UserStorageProviderModel() - Constructor for class org.keycloak.storage.UserStorageProviderModel
 
UserStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.UserStorageProviderModel
 
UserStorageProviderModel.CachePolicy - Enum in org.keycloak.storage
 
UserStorageProviderSpi - Class in org.keycloak.storage
 
UserStorageProviderSpi() - Constructor for class org.keycloak.storage.UserStorageProviderSpi
 
useTemplateConfig() - Method in interface org.keycloak.models.ClientModel
 
useTemplateMappers() - Method in interface org.keycloak.models.ClientModel
 
useTemplateScope() - Method in interface org.keycloak.models.ClientModel
 

V

validate(RealmModel, UserModel, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
 
validate(String, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
 
validate(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.ImportedUserValidation
 
validateAndProxy(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Gives the provider an option to validate if user still exists in federation backend and then proxy UserModel loaded from local storage.
validateAndProxyUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
 
validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory
 
validateHOTP(String, String, int) - Method in class org.keycloak.models.utils.HmacOTP
 
validateSecret(String) - Method in interface org.keycloak.models.ClientModel
 
validateUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
validCredentials(RealmModel, UserCredentialModel) - Method in interface org.keycloak.models.UserFederationProvider
Deprecated.
Validate credentials of unknown user.
value - Variable in class org.keycloak.models.UserCredentialModel
 
valueOf(String) - Static method in enum org.keycloak.keys.KeyMetadata.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.keys.KeyMetadata.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClientSessionModel.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClientSessionModel.ExecutionStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.KeycloakTransactionManager.JTAPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserFederationProvider.EditMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserModel.RequiredAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserSessionModel.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.storage.UserStorageProviderModel.CachePolicy
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.keycloak.keys.KeyMetadata.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.keys.KeyMetadata.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClientSessionModel.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClientSessionModel.ExecutionStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.KeycloakTransactionManager.JTAPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserFederationProvider.EditMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserModel.RequiredAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserSessionModel.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.storage.UserStorageProviderModel.CachePolicy
Returns an array containing the constants of this enum type, in the order they are declared.
verify(String, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
 

X

X509CERTIFICATE - Static variable in interface org.keycloak.models.ClientModel
 
A B C D E F G H I J K L M N O P Q R S T U V X 
Skip navigation links
Keycloak Server SPI 2.4.0.CR1

Copyright © 2016 JBoss by Red Hat. All rights reserved.