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

A

AbstractAuthenticationFlowContext - Interface in org.keycloak.authentication
 
AbstractIdentityProvider<C extends IdentityProviderModel> - Class in org.keycloak.broker.provider
 
AbstractIdentityProvider(KeycloakSession, C) - Constructor for class org.keycloak.broker.provider.AbstractIdentityProvider
 
AbstractIdentityProviderFactory<T extends IdentityProvider> - Class in org.keycloak.broker.provider
 
AbstractIdentityProviderFactory() - Constructor for class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
AbstractIdentityProviderMapper - Class in org.keycloak.broker.provider
 
AbstractIdentityProviderMapper() - Constructor for class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
AbstractLoginProtocolFactory - Class in org.keycloak.protocol
 
AbstractLoginProtocolFactory() - Constructor for class org.keycloak.protocol.AbstractLoginProtocolFactory
 
ACCOUNT_MANAGEMENT_CLIENT_ID - Static variable in interface org.keycloak.models.Constants
 
AccountPages - Enum in org.keycloak.forms.account
 
AccountProvider - Interface in org.keycloak.forms.account
 
AccountProviderFactory - Interface in org.keycloak.forms.account
 
AccountRoles - Interface in org.keycloak.models
 
AccountSpi - Class in org.keycloak.forms.account
 
AccountSpi() - Constructor for class org.keycloak.forms.account.AccountSpi
 
action(AuthenticationFlowContext) - Method in interface org.keycloak.authentication.Authenticator
Called from a form action invocation.
addActions(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addAdminRole(RealmModel, String) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
addAssociatedPolicy(Policy) - Method in interface org.keycloak.authorization.model.Policy
 
addCriteria(PropertyCriteria) - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Add a criteria to query
addDefaults(ClientModel) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
addError(FormMessage) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
addFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
addIdentityProviderAuthenticator(RealmModel, String) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
addRequiredAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
addRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
 
addResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
ADDRESS - Static variable in class org.keycloak.models.ClaimMask
 
addScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
addScript(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
Adds a script to the html header
addSuccess(FormMessage) - Method in interface org.keycloak.forms.login.LoginFormsProvider
Add a success message to the form
ADMIN - Static variable in class org.keycloak.models.AdminRoles
 
ADMIN_CLI_CLIENT_ID - Static variable in interface org.keycloak.models.Constants
 
ADMIN_CONSOLE_CLIENT_ID - Static variable in interface org.keycloak.models.Constants
 
AdminEvent - Class in org.keycloak.events.admin
 
AdminEvent() - Constructor for class org.keycloak.events.admin.AdminEvent
 
AdminEventQuery - Interface in org.keycloak.events.admin
 
AdminRoles - Class in org.keycloak.models
 
AdminRoles() - Constructor for class org.keycloak.models.AdminRoles
 
ALL - Static variable in interface org.keycloak.cluster.ClusterProvider
Special value to be used with ClusterProvider.registerListener(java.lang.String, org.keycloak.cluster.ClusterListener) to specify that particular listener will be always triggered for all notifications with any key.
ALL - Static variable in interface org.keycloak.models.AccountRoles
 
ALL - Static variable in class org.keycloak.models.ClaimMask
 
ALL_REALM_ROLES - Static variable in class org.keycloak.models.AdminRoles
 
AnnotatedPropertyCriteria - Class in org.keycloak.models.utils.reflection
A criteria that matches a property based on its annotations
AnnotatedPropertyCriteria(Class<? extends Annotation>) - Constructor for class org.keycloak.models.utils.reflection.AnnotatedPropertyCriteria
 
ANY_PROVIDER - Static variable in interface org.keycloak.broker.provider.IdentityProviderMapper
 
APP_SUFFIX - Static variable in class org.keycloak.models.AdminRoles
 
asDate(int, String) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asInetAddress(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asInt(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asLong(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asStatus() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asString(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asString() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
attachUserSession(UserSessionModel) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
 
attachUserSession(UserSessionModel, ClientSessionModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
attachUserSession(UserSessionModel, ClientSessionModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
attempted() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
There was no failure or challenge.
Attributes - Interface in org.keycloak.authorization.attribute
Holds attributes, their values and provides utlity methods to manage them.
Attributes.Entry - Class in org.keycloak.authorization.attribute
Holds an attribute and its values, providing useful methods for obtaining and formatting values.
AUTH_METHOD - Static variable in interface org.keycloak.events.Details
 
AUTH_TYPE - Static variable in interface org.keycloak.events.Details
 
AUTH_TYPE - Static variable in class org.keycloak.models.LDAPConstants
 
AUTH_TYPE_NONE - Static variable in class org.keycloak.models.LDAPConstants
 
AUTH_TYPE_SIMPLE - Static variable in class org.keycloak.models.LDAPConstants
 
authClient(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by authenticated client
AuthDetails - Class in org.keycloak.events.admin
 
AuthDetails() - Constructor for class org.keycloak.events.admin.AuthDetails
 
authenticate(AuthenticationFlowContext) - Method in interface org.keycloak.authentication.Authenticator
Initial call for the authenticator.
authenticateClient(ClientAuthenticationFlowContext) - Method in interface org.keycloak.authentication.ClientAuthenticator
Initial call for the authenticator.
authenticated(BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
This method should be called by provider after the JAXRS callback endpoint has finished authentication with the remote IDP
authenticated(UserSessionModel, ClientSessionCode) - Method in interface org.keycloak.protocol.LoginProtocol
 
AuthenticationFlow - Interface in org.keycloak.authentication
 
AuthenticationFlowContext - Interface in org.keycloak.authentication
This interface encapsulates information about an execution in an AuthenticationFlow.
AuthenticationFlowError - Enum in org.keycloak.authentication
Set of error codes that can be thrown by an Authenticator, FormAuthenticator, or FormAction
AuthenticationFlowException - Exception in org.keycloak.authentication
Throw this exception from an Authenticator, FormAuthenticator, or FormAction if you want to completely abort the flow.
AuthenticationFlowException(AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(String, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(String, Throwable, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(Throwable, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(String, Throwable, boolean, boolean, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationRequest - Class in org.keycloak.broker.provider
 
AuthenticationRequest(KeycloakSession, RealmModel, ClientSessionModel, HttpRequest, UriInfo, String, String) - Constructor for class org.keycloak.broker.provider.AuthenticationRequest
 
Authenticator - Interface in org.keycloak.authentication
This interface is for users that want to add custom authenticators to an authentication flow.
AuthenticatorFactory - Interface in org.keycloak.authentication
Factory for creating Authenticator instances.
AuthenticatorSpi - Class in org.keycloak.authentication
 
AuthenticatorSpi() - Constructor for class org.keycloak.authentication.AuthenticatorSpi
 
authIpAddress(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by request ip address
AuthorizationProvider - Class in org.keycloak.authorization
The main contract here is the creation of PermissionEvaluator instances.
AuthorizationProvider(KeycloakSession, RealmModel, StoreFactory, Executor) - Constructor for class org.keycloak.authorization.AuthorizationProvider
 
AuthorizationProvider(KeycloakSession, RealmModel, StoreFactory) - Constructor for class org.keycloak.authorization.AuthorizationProvider
 
AuthorizationProviderFactory - Interface in org.keycloak.authorization
 
AuthorizationSpi - Class in org.keycloak.authorization
 
AuthorizationSpi() - Constructor for class org.keycloak.authorization.AuthorizationSpi
 
AuthorizationStoreFactory - Interface in org.keycloak.authorization.store
 
AuthQuery - Class in org.keycloak.events.admin
 
AuthQuery() - Constructor for class org.keycloak.events.admin.AuthQuery
 
authRealm(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by authentication realm
authUser(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by authenticated user
AUTHZ_DEFAULT_AUTHORIZATION_ROLES - Static variable in interface org.keycloak.models.Constants
 
AUTHZ_UMA_AUTHORIZATION - Static variable in interface org.keycloak.models.Constants
 
AUTHZ_UMA_PROTECTION - Static variable in interface org.keycloak.models.Constants
 

B

backchannelLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
backchannelLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
backchannelLogout(UserSessionModel, ClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
BASE_DN - Static variable in class org.keycloak.models.LDAPConstants
 
BASIC_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
BATCH_SIZE_FOR_SYNC - Static variable in class org.keycloak.models.LDAPConstants
 
BIND_CREDENTIAL - Static variable in class org.keycloak.models.LDAPConstants
 
BIND_DN - Static variable in class org.keycloak.models.LDAPConstants
 
BROKER_SERVICE_CLIENT_ID - Static variable in interface org.keycloak.models.Constants
 
BROKER_SERVICE_ROLES - Static variable in interface org.keycloak.models.Constants
 
BrokeredIdentityContext - Class in org.keycloak.broker.provider
Represents all identity information obtained from an IdentityProvider after a successful authentication.
BrokeredIdentityContext(String) - Constructor for class org.keycloak.broker.provider.BrokeredIdentityContext
 
BROWSER_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
browserFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
browserFlow(RealmModel, boolean) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
BrowserSecurityHeaders - Class in org.keycloak.models
 
BrowserSecurityHeaders() - Constructor for class org.keycloak.models.BrowserSecurityHeaders
 
BruteForceProtector - Interface in org.keycloak.services.managers
 
BruteForceProtectorFactory - Interface in org.keycloak.services.managers
 
BruteForceProtectorSpi - Class in org.keycloak.services.managers
 
BruteForceProtectorSpi() - Constructor for class org.keycloak.services.managers.BruteForceProtectorSpi
 
buildGroupPath(StringBuilder, GroupModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
buildGroupPath(GroupModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
buildPage(FormContext, LoginFormsProvider) - Method in interface org.keycloak.authentication.FormAction
When a FormAuthenticator is rendering the challenge page, even FormAction.buildPage() method will be called This gives the FormAction the opportunity to add additional attributes to the form to be displayed.

C

CachedRealmModel - Interface in org.keycloak.models.cache
Cached realms will implement this interface
CachedRealmModel.RealmCachedEvent - Interface in org.keycloak.models.cache
 
CachedStoreFactoryProvider - Interface in org.keycloak.models.cache.authorization
 
CachedStoreFactorySpi - Class in org.keycloak.models.cache.authorization
 
CachedStoreFactorySpi() - Constructor for class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
CachedStoreProviderFactory - Interface in org.keycloak.models.cache.authorization
 
CacheRealmProvider - Interface in org.keycloak.models.cache
 
CacheRealmProviderFactory - Interface in org.keycloak.models.cache
 
CacheRealmProviderSpi - Class in org.keycloak.models.cache
 
CacheRealmProviderSpi() - Constructor for class org.keycloak.models.cache.CacheRealmProviderSpi
 
CacheUserProviderSpi - Class in org.keycloak.models.cache
 
CacheUserProviderSpi() - Constructor for class org.keycloak.models.cache.CacheUserProviderSpi
 
callback(RealmModel, IdentityProvider.AuthenticationCallback, EventBuilder) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
callback(RealmModel, IdentityProvider.AuthenticationCallback, EventBuilder) - Method in interface org.keycloak.broker.provider.IdentityProvider
JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.
cancelled(String) - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
 
cancelLogin() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
End the flow and redirect browser based on protocol specific respones.
cancelTask(String) - Method in interface org.keycloak.timer.TimerProvider
 
challenge(Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Sends a challenge response back to the HTTP client.
challenge(Response) - Method in interface org.keycloak.authentication.RequiredActionContext
Send a challenge Response back to user
check(ComponentModel) - Static method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkBoolean(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkBoolean(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkForcedUnlock() - Method in class org.keycloak.models.dblock.DBLockManager
 
checkInt(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkInt(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkLong(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkLong(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkRequired(ProviderConfigProperty) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkRequired(String, String) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkSingle(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkSingle(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
ClaimMask - Class in org.keycloak.models
 
ClaimMask() - Constructor for class org.keycloak.models.ClaimMask
 
clear() - Method in interface org.keycloak.events.EventStoreProvider
 
clear(String) - Method in interface org.keycloak.events.EventStoreProvider
 
clear(String, long) - Method in interface org.keycloak.events.EventStoreProvider
 
clear() - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
clearAdmin() - Method in interface org.keycloak.events.EventStoreProvider
 
clearAdmin(String) - Method in interface org.keycloak.events.EventStoreProvider
 
clearAdmin(String, long) - Method in interface org.keycloak.events.EventStoreProvider
 
clearDetachedUserSessions() - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
clearDetachedUserSessions() - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
clearExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
clearUser() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Clear the user from the flow.
clearUserSessionNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
client(ClientModel) - Method in class org.keycloak.events.EventBuilder
 
client(String) - Method in class org.keycloak.events.EventBuilder
 
client(String) - Method in interface org.keycloak.events.EventQuery
 
client - Variable in class org.keycloak.models.ClientConfigResolver
 
CLIENT_AUTH_METHOD - Static variable in interface org.keycloak.events.Details
 
CLIENT_AUTHENTICATION_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
CLIENT_DISABLED - Static variable in interface org.keycloak.events.Errors
 
CLIENT_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
CLIENT_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
CLIENT_REGISTRATION_POLICY - Static variable in interface org.keycloak.events.Details
 
CLIENT_SESSION_HOST - Static variable in interface org.keycloak.events.Details
 
CLIENT_SESSION_STATE - Static variable in interface org.keycloak.events.Details
 
ClientApplicationSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
ClientApplicationSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.ClientApplicationSynchronizer
 
ClientAuthenticationFlowContext - Interface in org.keycloak.authentication
Encapsulates information about the execution in ClientAuthenticationFlow
ClientAuthenticator - Interface in org.keycloak.authentication
This interface is for users that want to add custom client authenticators to an authentication flow.
ClientAuthenticatorFactory - Interface in org.keycloak.authentication
Factory for creating ClientAuthenticator instances.
ClientAuthenticatorSpi - Class in org.keycloak.authentication
 
ClientAuthenticatorSpi() - Constructor for class org.keycloak.authentication.ClientAuthenticatorSpi
 
clientAuthFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
ClientConfigResolver - Class in org.keycloak.models
 
ClientConfigResolver(ClientModel) - Constructor for class org.keycloak.models.ClientConfigResolver
 
ClientInstallationProvider - Interface in org.keycloak.protocol
Provides a template/sample client config adapter file.
ClientInstallationSpi - Class in org.keycloak.protocol
 
ClientInstallationSpi() - Constructor for class org.keycloak.protocol.ClientInstallationSpi
 
ClientSessionCode - Class in org.keycloak.services.managers
 
ClientSessionCode(KeycloakSession, RealmModel, ClientSessionModel) - Constructor for class org.keycloak.services.managers.ClientSessionCode
 
ClientSessionCode.ActionType - Enum in org.keycloak.services.managers
 
ClientSessionCode.ParseResult - Class in org.keycloak.services.managers
 
clientTemplate - Variable in class org.keycloak.models.ClientConfigResolver
 
clone() - Method in class org.keycloak.events.Event
 
clone() - Method in class org.keycloak.events.EventBuilder
 
close() - Method in class org.keycloak.authorization.AuthorizationProvider
 
close() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
close() - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
close() - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
close() - Method in interface org.keycloak.credential.CredentialProviderFactory
 
close() - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
close() - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
close() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
close() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
close() - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
close() - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
ClusterEvent - Interface in org.keycloak.cluster
 
ClusterListener - Interface in org.keycloak.cluster
Task to be executed on all cluster nodes once it's notified.
ClusterProvider - Interface in org.keycloak.cluster
Various utils related to clustering and concurrent tasks on cluster nodes
ClusterProviderFactory - Interface in org.keycloak.cluster
 
ClusterSpi - Class in org.keycloak.cluster
 
ClusterSpi() - Constructor for class org.keycloak.cluster.ClusterSpi
 
CN - Static variable in class org.keycloak.models.LDAPConstants
 
CODE_ID - Static variable in interface org.keycloak.events.Details
 
COMMA - Static variable in class org.keycloak.models.LDAPConstants
 
ComponentUtil - Class in org.keycloak.models.utils
 
ComponentUtil() - Constructor for class org.keycloak.models.utils.ComponentUtil
 
ConfigConstants - Interface in org.keycloak.broker.provider
 
ConfigurableAuthenticatorFactory - Interface in org.keycloak.authentication
 
ConfigurationValidationHelper - Class in org.keycloak.provider
 
configureBindings(Bindings) - Method in interface org.keycloak.scripting.ScriptBindingsConfigurer
 
configuredFor(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.Authenticator
Is this authenticator configured for this user.
configuredFor(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.FormAction
Is this FormAction configured for the current user?
CONNECTION_POOLING - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_URL - Static variable in class org.keycloak.models.LDAPConstants
 
CONSENT - Static variable in interface org.keycloak.events.Details
 
CONSENT_DENIED - Static variable in interface org.keycloak.events.Errors
 
CONSENT_VALUE_CONSENT_GRANTED - Static variable in interface org.keycloak.events.Details
 
CONSENT_VALUE_NO_CONSENT_REQUIRED - Static variable in interface org.keycloak.events.Details
 
CONSENT_VALUE_PERSISTED_CONSENT - Static variable in interface org.keycloak.events.Details
 
Constants - Interface in org.keycloak.models
 
containsValue(String, String) - Method in interface org.keycloak.authorization.attribute.Attributes
Checks if there is an attribute with the given name and value.
convertCredential(CredentialRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
convertFedMapperToComponent(RealmModel, ComponentModel, UserFederationMapperRepresentation, String) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
convertFedProviderToComponent(String, UserFederationProviderRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
create() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
 
create(KeycloakSession, RealmModel) - Method in interface org.keycloak.authorization.AuthorizationProviderFactory
 
create(Policy, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
create(String, String, ResourceServer) - Method in interface org.keycloak.authorization.store.PolicyStore
Creates a new Policy instance.
create(String) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Creates a ResourceServer instance backed by this persistent storage implementation.
create(String, ResourceServer, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Creates a Resource instance backed by this persistent storage implementation.
create(String, ResourceServer) - Method in interface org.keycloak.authorization.store.ScopeStore
Creates a new Scope instance.
create(KeycloakSession) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
create(KeycloakSession, IdentityProviderModel) - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates an IdentityProvider based on the configuration contained in model.
create(KeycloakSession) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.keys.KeyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
create(KeycloakSession) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
create(ClassLoader, String) - Method in interface org.keycloak.provider.ProviderLoaderFactory
 
create(KeycloakSession) - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
CREATE_CLIENT - Static variable in class org.keycloak.models.AdminRoles
 
CREATE_REALM - Static variable in class org.keycloak.models.AdminRoles
 
CREATE_TIMESTAMP - Static variable in class org.keycloak.models.LDAPConstants
 
createAdminQuery() - Method in interface org.keycloak.events.EventStoreProvider
 
createClient(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createClient(KeycloakSession, RealmModel, ClientRepresentation, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
Does not create scope or role mappings!
createClientRoleMappings(ClientModel, UserModel, List<String>) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createClientScopeMappings(RealmModel, ClientModel, List<ScopeMappingRepresentation>) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createClientSession(ClientSessionModel, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
createClientSession(ClientSessionModel, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
createClientTemplate(KeycloakSession, RealmModel, ClientTemplateRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createCode() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createComponentModel(String, String, String, String, String...) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createCredentials(UserRepresentation, KeycloakSession, RealmModel, UserModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createErrorPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createFederatedClientRoleMappings(UserFederatedStorageProvider, RealmModel, ClientModel, UserRepresentation, List<String>) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createFederatedRoleMappings(UserFederatedStorageProvider, UserRepresentation, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createForm(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createIdpLinkConfirmLinkPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createIdpLinkEmailPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createInfoPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLogin() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginTotp() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createOAuthGrant(ClientSessionModel) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createPasswordReset() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createProperty(Method) - Static method in class org.keycloak.models.utils.reflection.Properties
Create a JavaBean style property from the specified method
createProtocolEndpoint(RealmModel, EventBuilder) - Method in interface org.keycloak.protocol.LoginProtocolFactory
 
createProviders(RealmModel) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createProviders(RealmModel, String, String) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createQuery() - Method in interface org.keycloak.events.EventStoreProvider
 
createQuery(Class<?>) - Static method in class org.keycloak.models.utils.reflection.PropertyQueries
Create a new PropertyQuery
createRegistration() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createResponse(AccountPages) - Method in interface org.keycloak.forms.account.AccountProvider
 
createResponse(UserModel.RequiredAction) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createRole(RealmModel, RoleRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createRoleMappings(UserRepresentation, UserModel, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createScript(String, String, String, String, String) - Method in interface org.keycloak.scripting.ScriptingProvider
Creates a new ScriptModel instance.
createUpdateProfilePage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createUser(KeycloakSession, RealmModel, UserRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createUserFederationMapperModel(String, String, String, String...) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createUserSession(UserSessionModel, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
createUserSession(UserSessionModel, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
CredentialProviderFactory<T extends CredentialProvider> - Interface in org.keycloak.credential
 
CredentialSpi - Class in org.keycloak.credential
 
CredentialSpi() - Constructor for class org.keycloak.credential.CredentialSpi
 
CredentialValidation - Class in org.keycloak.models.utils
 
CredentialValidation() - Constructor for class org.keycloak.models.utils.CredentialValidation
 
CUSTOM_ATTRIBUTE_CREATE_DATE - Static variable in class org.keycloak.models.LDAPConstants
 
CUSTOM_ATTRIBUTE_ENABLED - Static variable in class org.keycloak.models.LDAPConstants
 
CUSTOM_ATTRIBUTE_EXPIRY_DATE - Static variable in class org.keycloak.models.LDAPConstants
 
CUSTOM_REQUIRED_ACTION - Static variable in interface org.keycloak.events.Details
 
CUSTOM_USER_SEARCH_FILTER - Static variable in class org.keycloak.models.LDAPConstants
 

D

DBLockManager - Class in org.keycloak.models.dblock
 
DBLockManager(KeycloakSession) - Constructor for class org.keycloak.models.dblock.DBLockManager
 
DBLockProvider - Interface in org.keycloak.models.dblock
Global database lock to ensure that some actions in DB can be done just be one cluster node at a time.
DBLockProviderFactory - Interface in org.keycloak.models.dblock
 
DBLockSpi - Class in org.keycloak.models.dblock
 
DBLockSpi() - Constructor for class org.keycloak.models.dblock.DBLockSpi
 
Decision<D extends Evaluation> - Interface in org.keycloak.authorization
 
Decision.Effect - Enum in org.keycloak.authorization
 
DecisionResultCollector - Class in org.keycloak.authorization.policy.evaluation
 
DecisionResultCollector() - Constructor for class org.keycloak.authorization.policy.evaluation.DecisionResultCollector
 
deepFindAuthenticationExecutions(RealmModel, AuthenticationFlowModel, List<AuthenticationExecutionModel>) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Recursively find all AuthenticationExecutionModel from specified flow or all it's subflows
DEFAULT_ACCESS_TOKEN_LIFESPAN_FOR_IMPLICIT_FLOW_TIMEOUT - Static variable in interface org.keycloak.models.Constants
 
DEFAULT_BATCH_SIZE_FOR_SYNC - Static variable in class org.keycloak.models.LDAPConstants
 
DEFAULT_DELAY_WINDOW - Static variable in class org.keycloak.models.utils.TimeBasedOTP
 
DEFAULT_INTERVAL_SECONDS - Static variable in class org.keycloak.models.utils.TimeBasedOTP
 
DEFAULT_MAX_RESULTS - Static variable in interface org.keycloak.models.Constants
 
DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT - Static variable in interface org.keycloak.models.Constants
 
DEFAULT_VALUE - Static variable in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
DEFAULT_VALUE - Static variable in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
DefaultAuthenticationFlows - Class in org.keycloak.models.utils
 
DefaultAuthenticationFlows() - Constructor for class org.keycloak.models.utils.DefaultAuthenticationFlows
 
DefaultDataMarshaller - Class in org.keycloak.broker.provider
 
DefaultDataMarshaller() - Constructor for class org.keycloak.broker.provider.DefaultDataMarshaller
 
DefaultEvaluation - Class in org.keycloak.authorization.policy.evaluation
 
DefaultEvaluation(ResourcePermission, EvaluationContext, Policy, Policy, Decision) - Constructor for class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
defaultHeaders - Static variable in class org.keycloak.models.BrowserSecurityHeaders
 
DefaultKeyProviders - Class in org.keycloak.models.utils
 
DefaultKeyProviders() - Constructor for class org.keycloak.models.utils.DefaultKeyProviders
 
DefaultPasswordPolicyManagerProvider - Class in org.keycloak.policy
 
DefaultPasswordPolicyManagerProvider(KeycloakSession) - Constructor for class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
DefaultPasswordPolicyManagerProviderFactory - Class in org.keycloak.policy
 
DefaultPasswordPolicyManagerProviderFactory() - Constructor for class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
DefaultPolicyEvaluator - Class in org.keycloak.authorization.policy.evaluation
 
DefaultPolicyEvaluator(AuthorizationProvider, List<PolicyProviderFactory>) - Constructor for class org.keycloak.authorization.policy.evaluation.DefaultPolicyEvaluator
 
DefaultRequiredActions - Class in org.keycloak.models.utils
 
DefaultRequiredActions() - Constructor for class org.keycloak.models.utils.DefaultRequiredActions
 
delegate - Variable in class org.keycloak.models.utils.UserModelDelegate
 
delete(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Deletes a policy from the underlying persistence mechanism.
delete(String) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Removes a ResourceServer instance, with the given id from the persistent storage.
delete(String) - Method in interface org.keycloak.authorization.store.ResourceStore
Removes a Resource instance, with the given id from the persistent storage.
delete(String) - Method in interface org.keycloak.authorization.store.ScopeStore
Deletes a scope from the underlying persistence mechanism.
deleteRoleMapping(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
deny() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
deny() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Denies the requested permission.
deserialize(String, Class<T>) - Method in class org.keycloak.broker.provider.DefaultDataMarshaller
 
deserialize(String, Class<T>) - Method in interface org.keycloak.broker.provider.IdentityProviderDataMarshaller
 
destroyLockInfo() - Method in interface org.keycloak.models.dblock.DBLockProvider
Will destroy whole state of DB lock (drop table/collection to track locking).
detail(String, String) - Method in class org.keycloak.events.EventBuilder
 
Details - Interface in org.keycloak.events
 
DigitsPasswordPolicyProvider - Class in org.keycloak.policy
 
DigitsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.DigitsPasswordPolicyProvider
 
DigitsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
DigitsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
DIRECT_GRANT_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
directGrantFlow(RealmModel, boolean) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
DisabledUserSessionPersisterProvider - Class in org.keycloak.models.session
Persistence of userSessions is disabled .
DisabledUserSessionPersisterProvider() - Constructor for class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
doGet(String) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doPost(String) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 

E

EDIT_MODE - Static variable in class org.keycloak.models.LDAPConstants
 
EMAIL - Static variable in interface org.keycloak.events.Details
 
EMAIL - Static variable in class org.keycloak.models.ClaimMask
 
EMAIL - Static variable in class org.keycloak.models.LDAPConstants
 
EMAIL_IN_USE - Static variable in interface org.keycloak.events.Errors
 
EMAIL_SEND_FAILED - Static variable in interface org.keycloak.events.Errors
 
EmailException - Exception in org.keycloak.email
 
EmailException(Throwable) - Constructor for exception org.keycloak.email.EmailException
 
EmailException(String, Throwable) - Constructor for exception org.keycloak.email.EmailException
 
EmailSenderProvider - Interface in org.keycloak.email
 
EmailSenderProviderFactory - Interface in org.keycloak.email
 
EmailSenderSpi - Class in org.keycloak.email
 
EmailSenderSpi() - Constructor for class org.keycloak.email.EmailSenderSpi
 
EmailTemplateProvider - Interface in org.keycloak.email
 
EmailTemplateProviderFactory - Interface in org.keycloak.email
 
EmailTemplateSpi - Class in org.keycloak.email
 
EmailTemplateSpi() - Constructor for class org.keycloak.email.EmailTemplateSpi
 
EMPTY - Static variable in interface org.keycloak.scripting.ScriptBindingsConfigurer
A default ScriptBindingsConfigurer that provides no Bindings.
EMPTY_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
EMPTY_MEMBER_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
encode(String, int) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
encode(String, PasswordPolicy, CredentialModel) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
encode(String) - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
ensureUniqueDisplayName(String, UserFederationProviderModel, List<UserFederationProviderModel>) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Ensure that displayName of myProvider (if not null) is unique and there is no other provider with same displayName in the list.
Entry(String, Collection<String>) - Constructor for class org.keycloak.authorization.attribute.Attributes.Entry
 
ENTRY_UUID - Static variable in class org.keycloak.models.LDAPConstants
 
EnvironmentDependentProviderFactory - Interface in org.keycloak.provider
Providers that are only supported in some environments can implement this interface to be able to determine if they should be available or not.
EQUAL - Static variable in class org.keycloak.models.LDAPConstants
 
equals(Object) - Method in class org.keycloak.migration.ModelVersion
 
equals(Object) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
equals(Object) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
error(String) - Method in interface org.keycloak.authentication.ValidationContext
 
error(String, String) - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
 
error(String) - Method in class org.keycloak.events.EventBuilder
 
errorMessage - Variable in exception org.keycloak.authentication.ForkFlowException
 
Errors - Interface in org.keycloak.events
 
evaluate(Decision) - Method in interface org.keycloak.authorization.permission.evaluator.PermissionEvaluator
 
evaluate(ResourcePermission, EvaluationContext, Decision) - Method in class org.keycloak.authorization.policy.evaluation.DefaultPolicyEvaluator
 
evaluate(ResourcePermission, EvaluationContext, Decision) - Method in interface org.keycloak.authorization.policy.evaluation.PolicyEvaluator
Starts the evaluation of the configured authorization policies.
evaluate(Evaluation) - Method in interface org.keycloak.authorization.policy.provider.PolicyProvider
 
evaluateTriggers(RequiredActionContext) - Method in interface org.keycloak.authentication.RequiredActionProvider
Called every time a uesr authenticates.
Evaluation - Interface in org.keycloak.authorization.policy.evaluation
An Evaluation is mainly used by PolicyProvider in order to evaluate a single and specific ResourcePermission against the configured policies.
EvaluationContext - Interface in org.keycloak.authorization.policy.evaluation
This interface serves as a bridge between the policy evaluation runtime and the environment in which it is running.
evaluators() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a Evaluators instance from where PolicyEvaluator instances can be obtained.
Evaluators - Class in org.keycloak.authorization.permission.evaluator
A factory for the different PermissionEvaluator implementations.
Evaluators(List<PolicyProviderFactory>, DefaultPolicyEvaluator, Executor) - Constructor for class org.keycloak.authorization.permission.evaluator.Evaluators
 
Event - Class in org.keycloak.events
 
Event() - Constructor for class org.keycloak.events.Event
 
event(EventType) - Method in class org.keycloak.events.EventBuilder
 
EventBuilder - Class in org.keycloak.events
 
EventBuilder(RealmModel, KeycloakSession, ClientConnection) - Constructor for class org.keycloak.events.EventBuilder
 
EventListenerProvider - Interface in org.keycloak.events
 
EventListenerProviderFactory - Interface in org.keycloak.events
 
EventListenerSpi - Class in org.keycloak.events
 
EventListenerSpi() - Constructor for class org.keycloak.events.EventListenerSpi
 
EventQuery - Interface in org.keycloak.events
 
eventReceived(ClusterEvent) - Method in interface org.keycloak.cluster.ClusterListener
Registered task to be executed on all cluster nodes once it's notified from cache.
EventStoreProvider - Interface in org.keycloak.events
 
EventStoreProviderFactory - Interface in org.keycloak.events
 
EventStoreSpi - Class in org.keycloak.events
 
EventStoreSpi() - Constructor for class org.keycloak.events.EventStoreSpi
 
EventType - Enum in org.keycloak.events
 
executed(T) - Static method in class org.keycloak.cluster.ExecutionResult
 
executeIfNotExecuted(String, int, Callable<T>) - Method in interface org.keycloak.cluster.ClusterProvider
Execute given task just if it's not already in progress (either on this or any other cluster node).
ExecutionResult<T> - Class in org.keycloak.cluster
 
exists(String) - Method in interface org.keycloak.authorization.attribute.Attributes
Checks if there is an attribute with the given name.
EXPIRED_CODE - Static variable in interface org.keycloak.events.Errors
 
export(UriInfo, RealmModel, String) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
export(UriInfo, RealmModel, String) - Method in interface org.keycloak.broker.provider.IdentityProvider
Export a representation of the IdentityProvider in a specific format.
exportAuthenticationFlows(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
exportGroups(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
exportModel(KeycloakSessionFactory) - Method in interface org.keycloak.exportimport.ExportProvider
 
ExportProvider - Interface in org.keycloak.exportimport
 
ExportProviderFactory - Interface in org.keycloak.exportimport
 
exportRealm(KeycloakSessionFactory, String) - Method in interface org.keycloak.exportimport.ExportProvider
 
exportRequiredActions(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
ExportSpi - Class in org.keycloak.exportimport
 
ExportSpi() - Constructor for class org.keycloak.exportimport.ExportSpi
 
exportUserFederationProvidersAndMappers(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 

F

failedLogin(RealmModel, UserModel, ClientConnection) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
failure(AuthenticationFlowError) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Aborts the current flow
failure(AuthenticationFlowError, Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Aborts the current flow.
failure() - Method in interface org.keycloak.authentication.RequiredActionContext
Abort the authentication with an error
failureChallenge(AuthenticationFlowError, Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Same behavior as challenge(), but the error count in brute force attack detection will be incremented.
FEDERATED_IDENTITY_EXISTS - Static variable in interface org.keycloak.events.Errors
 
FederationConfigValidationException - Exception in org.keycloak.mappers
 
FederationConfigValidationException(String) - Constructor for exception org.keycloak.mappers.FederationConfigValidationException
 
FederationConfigValidationException(String, Throwable) - Constructor for exception org.keycloak.mappers.FederationConfigValidationException
 
FederationConfigValidationException(String, Object...) - Constructor for exception org.keycloak.mappers.FederationConfigValidationException
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
fillInStackTrace() - Method in error org.keycloak.ServerStartupError
 
findByClient(String) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Returns a ResourceServer instance based on the identifier of a client application.
findById(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a Policy with the given id
findById(String) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Returns a ResourceServer instance based on its identifier.
findById(String) - Method in interface org.keycloak.authorization.store.ResourceStore
Returns a Resource instance based on its identifier.
findById(String) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a Scope with the given id
findByName(String, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a Policy with the given name
findByName(String, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Find a Resource by its name.
findByName(String, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a Scope with the given name
findByOwner(String) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances with the given ownerId.
findByResource(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a authorization.core.model.Resource with the given resourceId.
findByResourceServer(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a ResourceServer with the given resourceServerId.
findByResourceServer(Map<String, String[]>, String, int, int) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a ResourceServer with the given resourceServerId.
findByResourceServer(String) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances associated with a given resource server.
findByResourceServer(Map<String, String[]>, String, int, int) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances associated with a given resource server.
findByResourceServer(String) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a list of Scope associated with a ResourceServer with the given resourceServerId.
findByResourceServer(Map<String, String[]>, String, int, int) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a list of Scope associated with a ResourceServer with the given resourceServerId.
findByResourceType(String, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a authorization.core.model.Resource with the given type.
findByScope(String...) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource associated with a given scope.
findByScopeIds(List<String>, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a authorization.core.model.Scope with the given scopeIds.
findByType(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy with the given type.
findByType(String) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource with the given type.
findDependentPolicies(String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy that depends on another policy with the given id.
findGroupByPath(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
findUserByNameOrEmail(KeycloakSession, RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Try to find user by username or email
findUserFederationProviderByDisplayName(String, RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
findUserFederationProviderById(String, RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
findUserStorageProviderById(String, RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
findUserStorageProviderByName(String, RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
finishLogout(UserSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
FIRST_BROKER_LOGIN_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
FIRST_BROKER_LOGIN_HANDLE_EXISTING_SUBFLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
firstBrokerLoginFlow(RealmModel, boolean) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
firstResult(int) - Method in interface org.keycloak.events.admin.AdminEventQuery
Used for pagination
firstResult(int) - Method in interface org.keycloak.events.EventQuery
 
FlowStatus - Enum in org.keycloak.authentication
Status of an execution/authenticator in a Authentication Flow
forceChallenge(Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Sends the challenge back to the HTTP client irregardless of the current executionr equirement
ForceExpiredPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
ForceExpiredPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
fork() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Fork the current flow.
ForkFlowException - Exception in org.keycloak.authentication
Thrown internally when authenticator wants to fork the current flow.
ForkFlowException(FormMessage, FormMessage) - Constructor for exception org.keycloak.authentication.ForkFlowException
 
forkWithErrorMessage(FormMessage) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Fork the current flow.
forkWithSuccessMessage(FormMessage) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Fork the current flow.
form() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Create a Freemarker form builder that presets the user, action URI, and a generated access code
form() - Method in interface org.keycloak.authentication.RequiredActionContext
Create a Freemarker form builder that presets the user, action URI, and a generated access code
FORM_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
FormAction - Interface in org.keycloak.authentication
Fine grain processing of a form.
FormActionFactory - Interface in org.keycloak.authentication
Factory for instantiating FormAction objects.
FormActionSpi - Class in org.keycloak.authentication
 
FormActionSpi() - Constructor for class org.keycloak.authentication.FormActionSpi
 
FormAuthenticator - Interface in org.keycloak.authentication
This class is responsible for rendering a form.
FormAuthenticatorFactory - Interface in org.keycloak.authentication
Factory for instantiating FormAuthenticators.
FormAuthenticatorSpi - Class in org.keycloak.authentication
 
FormAuthenticatorSpi() - Constructor for class org.keycloak.authentication.FormAuthenticatorSpi
 
FormContext - Interface in org.keycloak.authentication
Interface that encapsulates the current state of the current form being executed
FormMessage - Class in org.keycloak.models.utils
Message (eg.
FormMessage() - Constructor for class org.keycloak.models.utils.FormMessage
 
FormMessage(String, String, Object...) - Constructor for class org.keycloak.models.utils.FormMessage
Create message.
FormMessage(String, Object...) - Constructor for class org.keycloak.models.utils.FormMessage
 
FormMessage(String, String) - Constructor for class org.keycloak.models.utils.FormMessage
Create message without parameters.
from(Map<String, Collection<String>>) - Static method in interface org.keycloak.authorization.attribute.Attributes
 
from(List<ResourcePermission>, EvaluationContext) - Method in class org.keycloak.authorization.permission.evaluator.Evaluators
 
fromDate(Date) - Method in interface org.keycloak.events.EventQuery
 
fromTime(Date) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by events after the specified time
frontchannelLogout(UserSessionModel, ClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 

G

GENDER - Static variable in class org.keycloak.models.ClaimMask
 
GENERATE - Static variable in interface org.keycloak.models.Constants
 
generateAccessCode() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
generateCode() - Method in interface org.keycloak.authentication.RequiredActionContext
Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
generateCodeSecret() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateId() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateInstallation(KeycloakSession, RealmModel, ClientModel, URI) - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
generateKeyPairCertificate(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateSecret() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateSecret(int) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateSecret(ClientModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateTOTP(String) - Method in class org.keycloak.models.utils.TimeBasedOTP
Generates a token.
get(String) - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
Helper method
getAction() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getAction() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getActionUrl(String) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Get the action URL for the required action.
getActionUrl() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Get the action URL for the required action.
getActionUrl(String) - Method in interface org.keycloak.authentication.RequiredActionContext
Get the action URL for the required action.
getActionUrl() - Method in interface org.keycloak.authentication.RequiredActionContext
Get the action URL for the required action.
getAdapterConfiguration(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client.
getAdminResource(ResourceServer) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getAnnotatedElement() - Method in interface org.keycloak.models.utils.reflection.MethodProperty
 
getAnnotatedElement() - Method in interface org.keycloak.models.utils.reflection.Property
Get the element responsible for retrieving the property value
getAssociatedPolicies() - Method in interface org.keycloak.authorization.model.Policy
Returns the Policy instances associated with this policy and used to evaluate authorization decisions when this policy applies.
getAssociatedPolicies() - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
getAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getAttributes() - Method in interface org.keycloak.authorization.identity.Identity
Returns the attributes or claims associated with this identity.
getAttributes() - Method in interface org.keycloak.authorization.policy.evaluation.EvaluationContext
Returns all attributes within the current execution and runtime environment.
getAttributes() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getAuthDetails() - Method in class org.keycloak.events.admin.AdminEvent
Returns authentication details
getAuthenticatedUser() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getAuthenticatorConfig() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Get any configuration associated with the current execution
getAuthenticatorConfig() - Method in interface org.keycloak.authentication.FormContext
Get any configuration associated with the current execution
getAuthMethod() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getAuthMethod() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getAuthMethod() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getAuthMethod() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getBaseType() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property type
getBrokerSessionId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getBrokerSessionId() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getBrokerSessionId() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getBrokerUserId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getBrokerUserId() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getBrokerUserId() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getBuiltinMappers(String) - Method in interface org.keycloak.migration.MigrationProvider
 
getBuiltinMappers() - Method in interface org.keycloak.protocol.LoginProtocolFactory
List of built in protocol mappers that can be used to apply to clients.
getCachedWith() - Method in interface org.keycloak.models.cache.CachedRealmModel
Returns a map that contains custom things that are cached along with this model.
getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedRealmModel
When was the model was loaded from database.
getCategoryRequirementFromCurrentFlow(String) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getCertificate(String) - Method in interface org.keycloak.keys.KeyProvider
Return the certificate for the specified kid, or null if the kid is unknown.
getCertificate(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getChallenge() - Method in interface org.keycloak.authentication.RequiredActionContext
If challenge has been sent this returns the JAX-RS Response
getClaimsMask(ClaimRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
getClient() - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Current client attached to this flow.
getClient() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getClientAuthAttributes() - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Return the map where the authenticators can put some additional state related to authenticated client and the context how was client authenticated (ie.
getClientId() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the identifier of the client application (which already exists in Keycloak) that is also acting as a resource server.
getClientId() - Method in class org.keycloak.events.admin.AuthDetails
 
getClientId() - Method in class org.keycloak.events.admin.AuthQuery
 
getClientId() - Method in class org.keycloak.events.Event
 
getClientId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getClientRoleMappings(ClientModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getClientScopeMappings(ClientModel, ScopeContainerModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getClientSession() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
ClientSessionModel attached to this flow
getClientSession() - Method in interface org.keycloak.authentication.FormContext
ClientSessionModel attached to this flow
getClientSession() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getClientSession() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getClientSession() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getClientSession(String, KeycloakSession, RealmModel) - Static method in class org.keycloak.services.managers.ClientSessionCode
 
getClientSession() - Method in class org.keycloak.services.managers.ClientSessionCode
 
getClientSession() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
getClientSessionId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getClientSessions() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getClientTemplateByName(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getClusterStartupTime() - Method in interface org.keycloak.cluster.ClusterProvider
Same value for all cluster nodes.
getCode() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getCode() - Method in class org.keycloak.scripting.Script
 
getCode() - Method in class org.keycloak.services.managers.ClientSessionCode
 
getCode() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
getCompatibleProviders() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getComponentConfigProperties(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentConfigProperties(KeycloakSession, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentFactory(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentFactory(KeycloakSession, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getConfig() - Method in interface org.keycloak.authorization.model.Policy
Returns a Map holding string-based key/value pairs representing any additional configuration for this policy.
getConfig() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
getConfigPropertiesPerClient() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
List of config properties for this client implementation.
getConfigType() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getConfigType() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getConnection() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Information about the IP address from the connecting HTTP client.
getConnection() - Method in interface org.keycloak.authentication.FormContext
Information about the IP address from the connecting HTTP client.
getConnection() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getContext() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
Returns the PermissionEvaluator.
getContext() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns the EvaluationContext.
getContextData() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getCreatedFederationProvider() - Method in class org.keycloak.models.UserFederationProviderCreationEventImpl
 
getCreatedTimestamp() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getData() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getData() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getDBLock() - Method in class org.keycloak.models.dblock.DBLockManager
 
getDBLockFactory() - Method in class org.keycloak.models.dblock.DBLockManager
 
getDecisionStrategy() - Method in interface org.keycloak.authorization.model.Policy
Returns the DecisionStrategy for this policy.
getDeclaringClass() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the class that declares the property
getDefaultBuiltinMappers() - Method in interface org.keycloak.protocol.LoginProtocolFactory
List of mappers, which are added to new clients by default
getDefaultClientAuthenticatorType() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getDefaultConfig(UserFederationProviderModel) - Method in interface org.keycloak.mappers.UserFederationMapperFactory
Used to detect what are default values for ProviderConfigProperties specified during mapper creation
getDefaultConfigValue() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getDelegate() - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
getDelegate() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getDelegateForUpdate() - Method in interface org.keycloak.models.cache.CachedRealmModel
Invalidates the cache for this model and returns a delegate that represents the actual data provider
getDescription() - Method in interface org.keycloak.authorization.model.Policy
Returns the description of this policy.
getDescription() - Method in class org.keycloak.scripting.Script
 
getDetails() - Method in class org.keycloak.events.Event
 
getDettachedClientSessionLifespan(RealmModel) - Static method in class org.keycloak.models.utils.RealmInfoUtil
 
getDisplayCategory() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getDisplayCategory() - Method in interface org.keycloak.mappers.UserFederationMapperFactory
 
getDisplayCategory() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getDisplayName() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getDisplayName() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getDisplayText() - Method in interface org.keycloak.authentication.RequiredActionFactory
Display text used in admin console to reference this required action
getDisplayType() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
Friendly name for the authenticator
getDisplayType() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getDisplayType() - Method in interface org.keycloak.mappers.UserFederationMapperFactory
 
getDisplayType() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getDisplayType() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getDuplicateFieldName() - Method in exception org.keycloak.models.ModelDuplicateException
 
getEffect() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getEffect() - Method in class org.keycloak.authorization.policy.evaluation.Result
 
getEmail() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getEmail() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getError() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Get the error condition of a failed execution.
getError() - Method in exception org.keycloak.authentication.AuthenticationFlowException
 
getError() - Method in class org.keycloak.events.admin.AdminEvent
If the event was unsuccessful returns the error message.
getError() - Method in class org.keycloak.events.Event
 
getErrorMessage() - Method in exception org.keycloak.authentication.ForkFlowException
 
getEvent() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Current event builder being used
getEvent() - Method in interface org.keycloak.authentication.FormContext
Current event builder being used
getEvent() - Method in interface org.keycloak.authentication.RequiredActionContext
Current event builder being used
getEvent() - Method in class org.keycloak.events.EventBuilder
 
getExecution() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
The current execution in the flow
getExecution() - Method in interface org.keycloak.authentication.FormContext
The current execution in the flow
getExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getFederationLink() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getFederationProviderFactory(KeycloakSession, UserFederationProviderModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getFederationProviderInstance(KeycloakSession, UserFederationProviderModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getFederationProviderType() - Method in interface org.keycloak.mappers.UserFederationMapperFactory
Refers to providerName (type) of the federated provider, which this mapper can be used for.
getField() - Method in class org.keycloak.models.utils.FormMessage
 
getFilename() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getFirstAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getFirstName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getFirstName() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getFirstResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get the first result from the query, causing the query to be run.
getFirstWritableResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get the first result from the query that is not marked as read only, causing the query to be run.
getForwardedErrorMessage() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
This could be an error message forwarded from another authenticator that is restarting or continuing the flo.
getForwardedSuccessMessage() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
This could be an success message forwarded from another authenticator that is restarting or continuing the flow.
getGroup() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getGroupMembers(UserFederationMapperModel, UserFederationProvider, RealmModel, GroupModel, int, int) - Method in interface org.keycloak.mappers.UserFederationMapper
Return empty list if doesn't support storing of groups
getGroups() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getHelpText() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getHttpClient() - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
 
getHttpRequest() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getHttpRequest() - Method in interface org.keycloak.authentication.FormContext
 
getHttpRequest() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getHttpRequest() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getIconUri() - Method in interface org.keycloak.authorization.model.Resource
Returns an icon URI for this resource.
getIconUri() - Method in interface org.keycloak.authorization.model.Scope
Returns an icon URI for this scope.
getId() - Method in interface org.keycloak.authorization.identity.Identity
Returns the unique identifier of this identity.
getId() - Method in interface org.keycloak.authorization.model.Policy
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.Resource
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.Scope
Returns the unique identifier for this instance.
getId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getId() - Method in interface org.keycloak.credential.CredentialProviderFactory
This is the name of the provider and will be showed in the admin console as an option.
getId() - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
getId() - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
getId() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getId() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getId() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getId() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
getId() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.scripting.Script
 
getIdentity() - Method in interface org.keycloak.authorization.policy.evaluation.EvaluationContext
Returns the Identity that represents an entity (person or non-person) to which the permissions must be granted, or not.
getIdentityProviderDisplayName(KeycloakSession, IdentityProviderModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getIdp() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getIdpConfig() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getImportName() - Method in interface org.keycloak.theme.Theme
 
getInterface(Class<T>) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
getInterface(Object, Class<T>) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
getIpAddress() - Method in class org.keycloak.events.admin.AuthDetails
 
getIpAddress() - Method in class org.keycloak.events.admin.AuthQuery
 
getIpAddress() - Method in class org.keycloak.events.Event
 
getIpAddress() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getIpAddress() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getJavaClass() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property type
getKeycloakSession() - Method in class org.keycloak.authorization.AuthorizationProvider
 
getKeycloakSession() - Method in interface org.keycloak.models.cache.CachedRealmModel.RealmCachedEvent
 
getKeyMetadata() - Method in interface org.keycloak.keys.KeyProvider
Return metadata about all keypairs held by the provider
getKid() - Method in interface org.keycloak.keys.KeyProvider
Return the KID for the active keypair, or null if no active key is available.
getLastName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getLastName() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getLastSessionRefresh() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getLastSessionRefresh() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getLogic() - Method in interface org.keycloak.authorization.model.Policy
Returns the Logic for this policy.
getLoginUsername() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getMajor() - Method in class org.keycloak.migration.ModelVersion
 
getMappersForClaimMask(Long) - Method in interface org.keycloak.migration.MigrationProvider
 
getMarshaller() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
getMarshaller() - Method in interface org.keycloak.broker.provider.IdentityProvider
Implementation of marshaller to serialize/deserialize attached data to Strings, which can be saved in clientSession
getMasterRealmAdminApplicationClientId(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getMediaType() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getMember() - Method in interface org.keycloak.models.utils.reflection.Property
Get the member responsible for retrieving the property value
getMessage() - Method in class org.keycloak.models.utils.FormMessage
 
getMessageDigest() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
getMessageKey() - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
getMessages(Locale) - Method in interface org.keycloak.theme.Theme
Same as getMessages(baseBundlename, locale), but uses a default baseBundlename such as "messages".
getMessages(String, Locale) - Method in interface org.keycloak.theme.Theme
Retrieve localized messages from a message bundle.
getMicro() - Method in class org.keycloak.migration.ModelVersion
 
getMimeType() - Method in class org.keycloak.scripting.Script
 
getMinor() - Method in class org.keycloak.migration.ModelVersion
 
getModelUsername() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
username to store in UserModel
getName() - Method in class org.keycloak.authentication.AuthenticatorSpi
 
getName() - Method in class org.keycloak.authentication.ClientAuthenticatorSpi
 
getName() - Method in class org.keycloak.authentication.FormActionSpi
 
getName() - Method in class org.keycloak.authentication.FormAuthenticatorSpi
 
getName() - Method in class org.keycloak.authentication.RequiredActionSpi
 
getName() - Method in class org.keycloak.authorization.AuthorizationSpi
 
getName() - Method in interface org.keycloak.authorization.model.Policy
Returns the name of this policy.
getName() - Method in interface org.keycloak.authorization.model.Resource
Returns the resource's name.
getName() - Method in interface org.keycloak.authorization.model.Scope
Returns the name of this scope.
getName() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getName() - Method in class org.keycloak.authorization.policy.provider.PolicySpi
 
getName() - Method in class org.keycloak.authorization.store.StoreFactorySpi
 
getName() - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
A friendly name for this factory.
getName() - Method in class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
getName() - Method in class org.keycloak.broker.provider.IdentityProviderSpi
 
getName() - Method in class org.keycloak.broker.social.SocialProviderSpi
 
getName() - Method in class org.keycloak.cluster.ClusterSpi
 
getName() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getName() - Method in class org.keycloak.credential.CredentialSpi
 
getName() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getName() - Method in class org.keycloak.email.EmailSenderSpi
 
getName() - Method in class org.keycloak.email.EmailTemplateSpi
 
getName() - Method in class org.keycloak.events.EventListenerSpi
 
getName() - Method in class org.keycloak.events.EventStoreSpi
 
getName() - Method in class org.keycloak.exportimport.ExportSpi
 
getName() - Method in class org.keycloak.exportimport.ImportSpi
 
getName() - Method in class org.keycloak.forms.account.AccountSpi
 
getName() - Method in class org.keycloak.forms.login.LoginFormsSpi
 
getName() - Method in class org.keycloak.keys.KeySpi
 
getName() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
getName() - Method in class org.keycloak.mappers.UserFederationMapperSpi
 
getName() - Method in class org.keycloak.migration.MigrationSpi
 
getName() - Method in class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
getName() - Method in class org.keycloak.models.cache.CacheRealmProviderSpi
 
getName() - Method in class org.keycloak.models.cache.CacheUserProviderSpi
 
getName() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getName() - Method in class org.keycloak.models.RealmSpi
 
getName() - Method in class org.keycloak.models.session.UserSessionPersisterSpi
 
getName() - Method in class org.keycloak.models.UserFederationSpi
 
getName() - Method in class org.keycloak.models.UserSessionSpi
 
getName() - Method in class org.keycloak.models.UserSpi
 
getName() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the name of the property.
getName() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getName() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getName() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getName() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getName() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getName() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getName() - Method in class org.keycloak.scripting.Script
 
getName() - Method in class org.keycloak.scripting.ScriptingSpi
 
getName() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getName() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getName() - Method in interface org.keycloak.theme.Theme
 
getName() - Method in class org.keycloak.theme.ThemeSpi
 
getName() - Method in class org.keycloak.timer.TimerSpi
 
getName() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getName() - Method in class org.keycloak.truststore.TruststoreSpi
 
getNote(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getNote(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getNotes() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getNotes() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getOperationalInfo() - Method in interface org.keycloak.provider.ServerInfoAwareProviderFactory
Return actual info about the provider.
getOperationType() - Method in class org.keycloak.events.admin.AdminEvent
Returns the type of the operation
getOwner() - Method in interface org.keycloak.authorization.model.Resource
Returns the resource's owner, which is usually an identifier that uniquely identifies the resource's owner.
getParameters() - Method in exception org.keycloak.mappers.FederationConfigValidationException
 
getParameters() - Method in exception org.keycloak.models.ModelException
 
getParameters() - Method in class org.keycloak.models.utils.FormMessage
 
getParameters() - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
getParentName() - Method in interface org.keycloak.theme.Theme
 
getParentPolicy() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getPemFromCertificate(X509Certificate) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPemFromKey(Key) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPermission() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
Returns the ResourcePermission to be evaluated.
getPermission() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns the ResourcePermission to be evaluated.
getPermission() - Method in class org.keycloak.authorization.policy.evaluation.Result
 
getPolicy() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getPolicy() - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
getPolicy() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getPolicyEnforcementMode() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the PolicyEnforcementMode configured for this instance.
getPolicyStore() - Method in interface org.keycloak.authorization.store.StoreFactory
Returns a PolicyStore.
getPrivateKey() - Method in interface org.keycloak.keys.KeyProvider
Return the private key for the active keypair, or null if no active key is available.
getPrivateKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getProperties() - Method in interface org.keycloak.theme.Theme
 
getProtector() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getProtocol() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getProtocol() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getProtocolAuthenticatorMethods(String) - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Get authentication methods for the specified protocol
getProtocolMappers() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getProtocolMappers() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getProviderClass() - Method in class org.keycloak.authentication.AuthenticatorSpi
 
getProviderClass() - Method in class org.keycloak.authentication.ClientAuthenticatorSpi
 
getProviderClass() - Method in class org.keycloak.authentication.FormActionSpi
 
getProviderClass() - Method in class org.keycloak.authentication.FormAuthenticatorSpi
 
getProviderClass() - Method in class org.keycloak.authentication.RequiredActionSpi
 
getProviderClass() - Method in class org.keycloak.authorization.AuthorizationSpi
 
getProviderClass() - Method in class org.keycloak.authorization.policy.provider.PolicySpi
 
getProviderClass() - Method in class org.keycloak.authorization.store.StoreFactorySpi
 
getProviderClass() - Method in class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
getProviderClass() - Method in class org.keycloak.broker.provider.IdentityProviderSpi
 
getProviderClass() - Method in class org.keycloak.broker.social.SocialProviderSpi
 
getProviderClass() - Method in class org.keycloak.cluster.ClusterSpi
 
getProviderClass() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getProviderClass() - Method in class org.keycloak.credential.CredentialSpi
 
getProviderClass() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getProviderClass() - Method in class org.keycloak.email.EmailSenderSpi
 
getProviderClass() - Method in class org.keycloak.email.EmailTemplateSpi
 
getProviderClass() - Method in class org.keycloak.events.EventListenerSpi
 
getProviderClass() - Method in class org.keycloak.events.EventStoreSpi
 
getProviderClass() - Method in class org.keycloak.exportimport.ExportSpi
 
getProviderClass() - Method in class org.keycloak.exportimport.ImportSpi
 
getProviderClass() - Method in class org.keycloak.forms.account.AccountSpi
 
getProviderClass() - Method in class org.keycloak.forms.login.LoginFormsSpi
 
getProviderClass() - Method in class org.keycloak.keys.KeySpi
 
getProviderClass() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
getProviderClass() - Method in class org.keycloak.mappers.UserFederationMapperSpi
 
getProviderClass() - Method in class org.keycloak.migration.MigrationSpi
 
getProviderClass() - Method in class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
getProviderClass() - Method in class org.keycloak.models.cache.CacheRealmProviderSpi
 
getProviderClass() - Method in class org.keycloak.models.cache.CacheUserProviderSpi
 
getProviderClass() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getProviderClass() - Method in class org.keycloak.models.RealmSpi
 
getProviderClass() - Method in class org.keycloak.models.session.UserSessionPersisterSpi
 
getProviderClass() - Method in class org.keycloak.models.UserFederationSpi
 
getProviderClass() - Method in class org.keycloak.models.UserSessionSpi
 
getProviderClass() - Method in class org.keycloak.models.UserSpi
 
getProviderClass() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getProviderClass() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getProviderClass() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getProviderClass() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getProviderClass() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getProviderClass() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getProviderClass() - Method in class org.keycloak.scripting.ScriptingSpi
 
getProviderClass() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getProviderClass() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getProviderClass() - Method in class org.keycloak.theme.ThemeSpi
 
getProviderClass() - Method in class org.keycloak.timer.TimerSpi
 
getProviderClass() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getProviderClass() - Method in class org.keycloak.truststore.TruststoreSpi
 
getProviderFactories() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns the registered PolicyProviderFactory.
getProviderFactory(String) - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a PolicyProviderFactory given a type.
getProviderFactoryClass() - Method in class org.keycloak.authentication.AuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.ClientAuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.FormActionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.FormAuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.RequiredActionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authorization.AuthorizationSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authorization.policy.provider.PolicySpi
 
getProviderFactoryClass() - Method in class org.keycloak.authorization.store.StoreFactorySpi
 
getProviderFactoryClass() - Method in class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
getProviderFactoryClass() - Method in class org.keycloak.broker.provider.IdentityProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.broker.social.SocialProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.cluster.ClusterSpi
 
getProviderFactoryClass() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getProviderFactoryClass() - Method in class org.keycloak.credential.CredentialSpi
 
getProviderFactoryClass() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getProviderFactoryClass() - Method in class org.keycloak.email.EmailSenderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.email.EmailTemplateSpi
 
getProviderFactoryClass() - Method in class org.keycloak.events.EventListenerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.events.EventStoreSpi
 
getProviderFactoryClass() - Method in class org.keycloak.exportimport.ExportSpi
 
getProviderFactoryClass() - Method in class org.keycloak.exportimport.ImportSpi
 
getProviderFactoryClass() - Method in class org.keycloak.forms.account.AccountSpi
 
getProviderFactoryClass() - Method in class org.keycloak.forms.login.LoginFormsSpi
 
getProviderFactoryClass() - Method in class org.keycloak.keys.KeySpi
 
getProviderFactoryClass() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
getProviderFactoryClass() - Method in class org.keycloak.mappers.UserFederationMapperSpi
 
getProviderFactoryClass() - Method in class org.keycloak.migration.MigrationSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.cache.CacheRealmProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.cache.CacheUserProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.RealmSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.session.UserSessionPersisterSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserFederationSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserSessionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserSpi
 
getProviderFactoryClass() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getProviderFactoryClass() - Method in class org.keycloak.scripting.ScriptingSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getProviderFactoryClass() - Method in class org.keycloak.theme.ThemeSpi
 
getProviderFactoryClass() - Method in class org.keycloak.timer.TimerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getProviderFactoryClass() - Method in class org.keycloak.truststore.TruststoreSpi
 
getProviderPriority() - Method in interface org.keycloak.theme.ThemeProvider
 
getPublicKey(String) - Method in interface org.keycloak.keys.KeyProvider
Return the public key for the specified kid, or null if the kid is unknown.
getPublicKey(String, String, PublicKeyLoader) - Method in interface org.keycloak.keys.PublicKeyStorageProvider
Get public key to verify messages signed by particular client.
getPublicKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getQualifier() - Method in class org.keycloak.migration.ModelVersion
 
getRealm() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Current realm
getRealm() - Method in interface org.keycloak.authentication.FormContext
Current realm
getRealm() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getRealm() - Method in class org.keycloak.authorization.AuthorizationProvider
 
getRealm() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getRealm() - Method in interface org.keycloak.models.cache.CachedRealmModel.RealmCachedEvent
 
getRealm() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRealm() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getRealm() - Method in class org.keycloak.models.UserFederationProviderCreationEventImpl
 
getRealmId() - Method in class org.keycloak.events.admin.AdminEvent
Returns the id of the realm
getRealmId() - Method in class org.keycloak.events.admin.AuthDetails
 
getRealmId() - Method in class org.keycloak.events.admin.AuthQuery
 
getRealmId() - Method in class org.keycloak.events.Event
 
getRealmId() - Method in class org.keycloak.scripting.Script
 
getRealmRoleMappings() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRedirectUri() - Method in class org.keycloak.broker.provider.AuthenticationRequest
Returns the redirect url that must be included in an authentication request in order to process responses from an identity provider.
getRedirectUri() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRedirectUri() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getReferenceCategory() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
General authenticator type, i.e.
getRepresentation() - Method in class org.keycloak.events.admin.AdminEvent
Returns the updated JSON representation if operationType is CREATE or UPDATE.
getRequestedProtocolMappers() - Method in class org.keycloak.services.managers.ClientSessionCode
 
getRequestedRoles() - Method in class org.keycloak.services.managers.ClientSessionCode
 
getRequiredActions() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRequiredActions() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getRequiredActions() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRequirementChoices() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
What requirement settings are allowed.
getResource() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns the resource to which this permission applies.
getResource() - Method in interface org.keycloak.services.resource.RealmResourceProvider
Returns a JAX-RS resource instance.
getResource(String) - Method in interface org.keycloak.theme.Theme
 
getResourceAsStream(String) - Method in interface org.keycloak.theme.Theme
 
getResourcePath() - Method in class org.keycloak.events.admin.AdminEvent
Returns the path of the resource.
getResources() - Method in interface org.keycloak.authorization.model.Policy
Returns the Resource instances where this policy applies.
getResourceServer() - Method in interface org.keycloak.authorization.model.Policy
Returns the ResourceServer where this policy belongs to.
getResourceServer() - Method in interface org.keycloak.authorization.model.Resource
Returns the ResourceServer to where this resource belongs to.
getResourceServer() - Method in interface org.keycloak.authorization.model.Scope
Returns the ResourceServer instance to where this scope belongs to.
getResourceServer() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns the resource server associated with this permission.
getResourceServerStore() - Method in interface org.keycloak.authorization.store.StoreFactory
getResourceStore() - Method in interface org.keycloak.authorization.store.StoreFactory
Returns a ResourceStore.
getResourceType() - Method in class org.keycloak.events.admin.AdminEvent
Returns the type of the affected ResourceType for this AdminEvent, e.g.
getResult() - Method in class org.keycloak.cluster.ExecutionResult
 
getResultList() - Method in interface org.keycloak.events.admin.AdminEventQuery
Executes the query and returns the results
getResultList() - Method in interface org.keycloak.events.EventQuery
 
getResultList() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get the result from the query, causing the query to be run.
getResults() - Method in class org.keycloak.authorization.policy.evaluation.Result
 
getRoleFromString(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getRoleMappings() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRoles() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRoles() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getScopes() - Method in interface org.keycloak.authorization.model.Policy
Returns the Scope instances where this policy applies.
getScopes() - Method in interface org.keycloak.authorization.model.Resource
Returns a List containing all the Scope associated with this resource.
getScopes() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns a list of permitted scopes associated with the resource
getScopeStore() - Method in interface org.keycloak.authorization.store.StoreFactory
Returns a ScopeStore.
getSecretKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getServiceAccountClientLink() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getSession() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Current session
getSession() - Method in interface org.keycloak.authentication.FormContext
Current session
getSession() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getSession() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getSessionId() - Method in class org.keycloak.events.Event
 
getSingleResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get a single result from the query, causing the query to be run.
getStarted() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getStarted() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getState() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getState() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getState() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getStatus() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Get the current status of the current execution.
getStatus() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getStatus() - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
getStoreFactory() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a StoreFactory.
getStrength() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
getSuccessMessage() - Method in exception org.keycloak.authentication.ForkFlowException
 
getSyncConfig() - Method in interface org.keycloak.mappers.UserFederationMapperFactory
Specifies if mapper supports sync data from federated storage to keycloak and viceversa.
getTemplate(String) - Method in interface org.keycloak.theme.Theme
 
getTemplateAsStream(String) - Method in interface org.keycloak.theme.Theme
 
getTheme(String, Theme.Type) - Method in interface org.keycloak.theme.ThemeProvider
 
getTime() - Method in class org.keycloak.events.admin.AdminEvent
Returns the time of the event
getTime() - Method in class org.keycloak.events.Event
 
getTimestamp() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getTimestamp() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getToken() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getTransactionManager() - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
getTruststore() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getType() - Method in interface org.keycloak.authorization.model.Policy
Returns the type of this policy.
getType() - Method in interface org.keycloak.authorization.model.Resource
Returns a string representing the type of this resource.
getType() - Method in class org.keycloak.events.Event
 
getType() - Method in interface org.keycloak.theme.Theme
 
getUpdatedModel() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getUpdatedModel() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getUri() - Method in interface org.keycloak.authorization.model.Resource
Returns a URI that uniquely identify this resource.
getUriInfo() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
UriInfo of the current request
getUriInfo() - Method in interface org.keycloak.authentication.FormContext
UriInfo of the current request
getUriInfo() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getUriInfo() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getUser() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Current user attached to this flow.
getUser() - Method in interface org.keycloak.authentication.FormContext
Current user attached to this flow.
getUser() - Method in interface org.keycloak.authentication.RequiredActionContext
Current user
getUser() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getUserAttribute(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getUserId() - Method in class org.keycloak.events.admin.AuthDetails
 
getUserId() - Method in class org.keycloak.events.admin.AuthQuery
 
getUserId() - Method in class org.keycloak.events.Event
 
getUserId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getUsername() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Username in remote idp
getUsername() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getUserSession() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getUserSession() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getUserSessionId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getUserSessionId() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getUserSessionNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getUserSessionNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getUserSessionsCount(boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
getUserSessionsCount(boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
getUuidAttributeName(String) - Static method in class org.keycloak.models.LDAPConstants
 
getValue(String) - Method in interface org.keycloak.authorization.attribute.Attributes
Returns a Attributes.Entry from where values can be obtained and parsed accordingly.
getValue(Object) - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property value for the specified bean.
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_2_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_3_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_4_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_5_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_6_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_7_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_8_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_9_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo1_9_2
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo2_0_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo2_1_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo2_2_0
 
getVersion() - Method in class org.keycloak.migration.migrators.MigrateTo2_3_0
 
getVersion() - Method in interface org.keycloak.migration.migrators.Migration
 
getWritableResultList() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get the non read only results from the query, causing the query to be run.
getWritableSingleResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get a single result from the query that is not marked as read only, causing the query to be run.
GIVENNAME - Static variable in class org.keycloak.models.LDAPConstants
 
GLOBAL - Static variable in class org.keycloak.models.utils.FormMessage
Value used for FormMessage.field if message is global (not tied to any specific form field)
grant() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
Grants all the requested permissions to the caller.
grant() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Grants the requested permission to the caller.
GRANT_TYPE - Static variable in interface org.keycloak.events.Details
 
grantRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
GROUP - Static variable in class org.keycloak.models.LDAPConstants
 
GROUP_OF_ENTRIES - Static variable in class org.keycloak.models.LDAPConstants
 
GROUP_OF_NAMES - Static variable in class org.keycloak.models.LDAPConstants
 
GROUP_OF_UNIQUE_NAMES - Static variable in class org.keycloak.models.LDAPConstants
 

H

hasAddress(long) - Static method in class org.keycloak.models.ClaimMask
 
hasClientRole(String, String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a client role with the given roleName.
hasClientRole(String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a client role with the given roleName.
hasEmail(long) - Static method in class org.keycloak.models.ClaimMask
 
hasGender(long) - Static method in class org.keycloak.models.ClaimMask
 
HashAlgorithmPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HashAlgorithmPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
hashCode() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
hashCode() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
HashIterationsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HashIterationsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
hasLocale(long) - Static method in class org.keycloak.models.ClaimMask
 
hasLock() - Method in interface org.keycloak.models.dblock.DBLockProvider
Check if I have lock
hasName(long) - Static method in class org.keycloak.models.ClaimMask
 
hasPhone(long) - Static method in class org.keycloak.models.ClaimMask
 
hasPicture(long) - Static method in class org.keycloak.models.ClaimMask
 
hasProfile(long) - Static method in class org.keycloak.models.ClaimMask
 
hasRealmRole(String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a realm role with the given roleName.
hasRole(String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a role (realm or client) with the given roleName.
hasRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
hasTheme(String, Theme.Type) - Method in interface org.keycloak.theme.ThemeProvider
 
hasUsername(long) - Static method in class org.keycloak.models.ClaimMask
 
hasWebsite(long) - Static method in class org.keycloak.models.ClaimMask
 
header(String, String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
headerAttributeMap - Static variable in class org.keycloak.models.BrowserSecurityHeaders
 
HistoryPasswordPolicyProvider - Class in org.keycloak.policy
 
HistoryPasswordPolicyProvider(KeycloakSession) - Constructor for class org.keycloak.policy.HistoryPasswordPolicyProvider
 
HistoryPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HistoryPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
HostnameVerificationPolicy - Enum in org.keycloak.truststore
 
hostnameVerifier(HostnameVerifier) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
HttpClientFactory - Interface in org.keycloak.connections.httpclient
 
HttpClientProvider - Interface in org.keycloak.connections.httpclient
 
HttpClientSpi - Class in org.keycloak.connections.httpclient
 
HttpClientSpi() - Constructor for class org.keycloak.connections.httpclient.HttpClientSpi
 

I

ID - Static variable in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
ID - Static variable in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
ID - Static variable in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
Identity - Interface in org.keycloak.authorization.identity
Represents a security identity, which can be a person or non-person entity that was previously authenticated.
IDENTITY_PROVIDER - Static variable in interface org.keycloak.events.Details
 
IDENTITY_PROVIDER_BROKER_CONTEXT - Static variable in interface org.keycloak.email.EmailTemplateProvider
 
IDENTITY_PROVIDER_BROKER_CONTEXT - Static variable in interface org.keycloak.forms.login.LoginFormsProvider
 
IDENTITY_PROVIDER_ERROR - Static variable in interface org.keycloak.events.Errors
 
IDENTITY_PROVIDER_LOGIN_FAILURE - Static variable in interface org.keycloak.events.Errors
 
IDENTITY_PROVIDER_SPI_NAME - Static variable in class org.keycloak.broker.provider.IdentityProviderSpi
 
IDENTITY_PROVIDER_USERNAME - Static variable in interface org.keycloak.events.Details
 
IdentityBrokerException - Exception in org.keycloak.broker.provider
 
IdentityBrokerException(String) - Constructor for exception org.keycloak.broker.provider.IdentityBrokerException
 
IdentityBrokerException(String, Throwable) - Constructor for exception org.keycloak.broker.provider.IdentityBrokerException
 
IdentityProvider<C extends IdentityProviderModel> - Interface in org.keycloak.broker.provider
 
IdentityProvider.AuthenticationCallback - Interface in org.keycloak.broker.provider
 
IdentityProviderDataMarshaller - Interface in org.keycloak.broker.provider
 
IdentityProviderFactory<T extends IdentityProvider> - Interface in org.keycloak.broker.provider
 
IdentityProviderMapper - Interface in org.keycloak.broker.provider
 
IdentityProviderMapperSpi - Class in org.keycloak.broker.provider
 
IdentityProviderMapperSpi() - Constructor for class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
IdentityProviderSpi - Class in org.keycloak.broker.provider
 
IdentityProviderSpi() - Constructor for class org.keycloak.broker.provider.IdentityProviderSpi
 
IDP_CREATE_UNIQUE_USER_CONFIG_ALIAS - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
IDP_REVIEW_PROFILE_CONFIG_ALIAS - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
ignore() - Method in interface org.keycloak.authentication.RequiredActionContext
Ignore this required action and go onto the next, or complete the flow.
IMPERSONATION_ROLE - Static variable in class org.keycloak.models.ImpersonationConstants
 
ImpersonationConstants - Class in org.keycloak.models
 
ImpersonationConstants() - Constructor for class org.keycloak.models.ImpersonationConstants
 
IMPERSONATOR - Static variable in interface org.keycloak.events.Details
 
IMPERSONATOR_REALM - Static variable in interface org.keycloak.events.Details
 
importAuthenticationFlows(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importAuthorizationSettings(ClientRepresentation, ClientModel, KeycloakSession) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importComponents(RealmModel, MultivaluedHashMap<String, ComponentExportRepresentation>, String) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importFederatedUser(KeycloakSession, RealmModel, UserRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importGroup(RealmModel, GroupModel, GroupRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importGroups(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importModel(KeycloakSessionFactory, Strategy) - Method in interface org.keycloak.exportimport.ImportProvider
 
importNewUser(KeycloakSession, RealmModel, UserModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
importNewUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
importNewUser(KeycloakSession, RealmModel, UserModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
importNewUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
Called after UserModel is created for first time for this user.
ImportProvider - Interface in org.keycloak.exportimport
 
ImportProviderFactory - Interface in org.keycloak.exportimport
 
importRealm(KeycloakSessionFactory, String, Strategy) - Method in interface org.keycloak.exportimport.ImportProvider
 
importRealm(RealmRepresentation) - Method in interface org.keycloak.models.utils.RealmImporter
 
importRealm(KeycloakSession, RealmRepresentation, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importRoles(RolesRepresentation, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
ImportSpi - Class in org.keycloak.exportimport
 
ImportSpi() - Constructor for class org.keycloak.exportimport.ImportSpi
 
importUserFederationProvidersAndMappers(KeycloakSession, RealmRepresentation, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
init(Config.Scope) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
init(Config.Scope) - Method in interface org.keycloak.credential.CredentialProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
init(Config.Scope) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
init(Config.Scope) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
INSTALLED_APP_URL - Static variable in interface org.keycloak.models.Constants
 
INSTALLED_APP_URN - Static variable in interface org.keycloak.models.Constants
 
introspect(String) - Method in interface org.keycloak.protocol.oidc.TokenIntrospectionProvider
Introspect the token.
INVALID_CLIENT - Static variable in interface org.keycloak.events.Errors
 
INVALID_CLIENT_CREDENTIALS - Static variable in interface org.keycloak.events.Errors
 
INVALID_CODE - Static variable in interface org.keycloak.events.Errors
 
INVALID_EMAIL - Static variable in interface org.keycloak.events.Errors
 
INVALID_FORM - Static variable in interface org.keycloak.events.Errors
 
INVALID_REDIRECT_URI - Static variable in interface org.keycloak.events.Errors
 
INVALID_REGISTRATION - Static variable in interface org.keycloak.events.Errors
 
INVALID_REQUEST - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_AUTHN_REQUEST - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_LOGOUT_REQUEST - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_LOGOUT_RESPONSE - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_RESPONSE - Static variable in interface org.keycloak.events.Errors
 
INVALID_SIGNATURE - Static variable in interface org.keycloak.events.Errors
 
INVALID_TOKEN - Static variable in interface org.keycloak.events.Errors
 
INVALID_USER_CREDENTIALS - Static variable in interface org.keycloak.events.Errors
 
invalidate() - Method in interface org.keycloak.models.cache.CachedRealmModel
Invalidate the cache for this model
InvocableScriptAdapter - Class in org.keycloak.scripting
Wraps a ScriptModel and makes it Invocable.
InvocableScriptAdapter(ScriptModel, ScriptEngine) - Constructor for class org.keycloak.scripting.InvocableScriptAdapter
Creates a new InvocableScriptAdapter instance.
invokeFunction(String, Object...) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
invokeMethod(Object, String, Object...) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
ipAddress(String) - Method in class org.keycloak.events.EventBuilder
 
ipAddress(String) - Method in interface org.keycloak.events.EventQuery
 
isActionActive(ClientSessionCode.ActionType) - Method in class org.keycloak.services.managers.ClientSessionCode
 
isAllowRemoteResourceManagement() - Method in interface org.keycloak.authorization.model.ResourceServer
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.
isAnnotationPresent(Class<? extends Annotation>) - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether the given annotation is defined for this property.
isClientSessionNotFound() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
isClientTemplateUsed(RealmModel, ClientTemplateModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
isConfigurable() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Is this authenticator configurable globally?
isConfigurable() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
Is this authenticator configurable?
isDefined(String) - Method in class org.keycloak.scripting.InvocableScriptAdapter
Returns true if the ScriptEngine has a definition with the given name.
isDownloadOnly() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
isEmailVerified() - Method in class org.keycloak.models.utils.UserModelDelegate
 
isEnabled() - Method in class org.keycloak.models.utils.UserModelDelegate
 
isExecuted() - Method in class org.keycloak.cluster.ExecutionResult
 
isFlowUsed(RealmModel, AuthenticationFlowModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Check to see if a flow is currently in use
isFrontchannelLogout() - Method in class org.keycloak.models.ClientConfigResolver
 
isIllegalHash() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
isInternal() - Method in class org.keycloak.authentication.AuthenticatorSpi
 
isInternal() - Method in class org.keycloak.authentication.ClientAuthenticatorSpi
 
isInternal() - Method in class org.keycloak.authentication.FormActionSpi
 
isInternal() - Method in class org.keycloak.authentication.FormAuthenticatorSpi
 
isInternal() - Method in class org.keycloak.authentication.RequiredActionSpi
 
isInternal() - Method in class org.keycloak.authorization.AuthorizationSpi
 
isInternal() - Method in class org.keycloak.authorization.policy.provider.PolicySpi
 
isInternal() - Method in class org.keycloak.authorization.store.StoreFactorySpi
 
isInternal() - Method in class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
isInternal() - Method in class org.keycloak.broker.provider.IdentityProviderSpi
 
isInternal() - Method in class org.keycloak.broker.social.SocialProviderSpi
 
isInternal() - Method in class org.keycloak.cluster.ClusterSpi
 
isInternal() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
isInternal() - Method in class org.keycloak.credential.CredentialSpi
 
isInternal() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
isInternal() - Method in class org.keycloak.email.EmailSenderSpi
 
isInternal() - Method in class org.keycloak.email.EmailTemplateSpi
 
isInternal() - Method in class org.keycloak.events.EventListenerSpi
 
isInternal() - Method in class org.keycloak.events.EventStoreSpi
 
isInternal() - Method in class org.keycloak.exportimport.ExportSpi
 
isInternal() - Method in class org.keycloak.exportimport.ImportSpi
 
isInternal() - Method in class org.keycloak.forms.account.AccountSpi
 
isInternal() - Method in class org.keycloak.forms.login.LoginFormsSpi
 
isInternal() - Method in class org.keycloak.keys.KeySpi
 
isInternal() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
isInternal() - Method in class org.keycloak.mappers.UserFederationMapperSpi
 
isInternal() - Method in class org.keycloak.migration.MigrationSpi
 
isInternal() - Method in class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
isInternal() - Method in class org.keycloak.models.cache.CacheRealmProviderSpi
 
isInternal() - Method in class org.keycloak.models.cache.CacheUserProviderSpi
 
isInternal() - Method in class org.keycloak.models.dblock.DBLockSpi
 
isInternal() - Method in class org.keycloak.models.RealmSpi
 
isInternal() - Method in class org.keycloak.models.session.UserSessionPersisterSpi
 
isInternal() - Method in class org.keycloak.models.UserFederationSpi
 
isInternal() - Method in class org.keycloak.models.UserSessionSpi
 
isInternal() - Method in class org.keycloak.models.UserSpi
 
isInternal() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
isInternal() - Method in class org.keycloak.policy.PasswordPolicySpi
 
isInternal() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
isInternal() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
isInternal() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
isInternal() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
isInternal() - Method in class org.keycloak.scripting.ScriptingSpi
 
isInternal() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
isInternal() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
isInternal() - Method in class org.keycloak.theme.ThemeSpi
 
isInternal() - Method in class org.keycloak.timer.TimerSpi
 
isInternal() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
isInternal() - Method in class org.keycloak.truststore.TruststoreSpi
 
isMasterRealmExported() - Method in interface org.keycloak.exportimport.ImportProvider
 
isMemberOf(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
isMultiplSupported() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
isMultiplSupported() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
isProperty(Method) - Static method in class org.keycloak.models.utils.reflection.Properties
Indicates whether this method is a valid property method.
isReadOnly() - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether this is a read-only property
isRememberMe() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
isRememberMe() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
isSaveByDefault() - Method in enum org.keycloak.events.EventType
 
isSupported() - Method in interface org.keycloak.provider.EnvironmentDependentProviderFactory
 
isTemporarilyDisabled(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
isUserSetupAllowed() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
Does this authenticator have required actions that can set if the user does not have this authenticator set up?
isValid(String, ClientSessionCode.ActionType) - Method in class org.keycloak.services.managers.ClientSessionCode
 
isValidAction(String) - Method in class org.keycloak.services.managers.ClientSessionCode
 

J

joinGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
JtaTransactionManagerLookup - Interface in org.keycloak.transaction
JTA TransactionManager lookup

K

KEY - Static variable in interface org.keycloak.models.Constants
 
keycloakInitiatedBrowserLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
keycloakInitiatedBrowserLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in interface org.keycloak.broker.provider.IdentityProvider
Called when a Keycloak application initiates a logout through the browser.
KeycloakModelUtils - Class in org.keycloak.models.utils
Set of helper methods, which are useful in various model implementations.
KeyProvider - Interface in org.keycloak.keys
 
KeyProviderFactory<T extends KeyProvider> - Interface in org.keycloak.keys
 
KeySpi - Class in org.keycloak.keys
 
KeySpi() - Constructor for class org.keycloak.keys.KeySpi
 

L

LDAP_ENTRY_DN - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_ID - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_MATCHING_RULE_IN_CHAIN - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_PROVIDER - Static variable in class org.keycloak.models.LDAPConstants
 
LDAPConstants - Class in org.keycloak.models
 
LDAPConstants() - Constructor for class org.keycloak.models.LDAPConstants
 
leaveGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
LengthPasswordPolicyProvider - Class in org.keycloak.policy
 
LengthPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.LengthPasswordPolicyProvider
 
LengthPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
LengthPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
lessThan(ModelVersion) - Method in class org.keycloak.migration.ModelVersion
 
load(Spi) - Method in interface org.keycloak.provider.ProviderLoader
Load all provider factories of a specific SPI.
loadKeys() - Method in interface org.keycloak.keys.PublicKeyLoader
 
loadPersistentSessions(KeycloakSessionFactory, int, int) - Method in interface org.keycloak.models.UserSessionProviderFactory
 
loadSpis() - Method in interface org.keycloak.provider.ProviderLoader
Load the SPI definitions themselves.
loadUserSessions(int, int, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
loadUserSessions(int, int, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
LOCALE - Static variable in class org.keycloak.models.ClaimMask
 
logger - Static variable in class org.keycloak.models.dblock.DBLockManager
 
LOGIN_FORMS_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
LoginFormsPages - Enum in org.keycloak.forms.login
 
LoginFormsProvider - Interface in org.keycloak.forms.login
 
LoginFormsProviderFactory - Interface in org.keycloak.forms.login
 
LoginFormsSpi - Class in org.keycloak.forms.login
 
LoginFormsSpi() - Constructor for class org.keycloak.forms.login.LoginFormsSpi
 
LoginProtocol - Interface in org.keycloak.protocol
 
LoginProtocol.Error - Enum in org.keycloak.protocol
 
LoginProtocolFactory - Interface in org.keycloak.protocol
 
LoginProtocolSpi - Class in org.keycloak.protocol
 
LoginProtocolSpi() - Constructor for class org.keycloak.protocol.LoginProtocolSpi
 
LowerCasePasswordPolicyProvider - Class in org.keycloak.policy
 
LowerCasePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
LowerCasePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
LowerCasePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 

M

MANAGE_ACCOUNT - Static variable in interface org.keycloak.models.AccountRoles
 
MANAGE_AUTHORIZATION - Static variable in class org.keycloak.models.AdminRoles
 
MANAGE_CLIENTS - Static variable in class org.keycloak.models.AdminRoles
 
MANAGE_EVENTS - Static variable in class org.keycloak.models.AdminRoles
 
MANAGE_IDENTITY_PROVIDERS - Static variable in class org.keycloak.models.AdminRoles
 
MANAGE_REALM - Static variable in class org.keycloak.models.AdminRoles
 
MANAGE_USERS - Static variable in class org.keycloak.models.AdminRoles
 
maxResults(int) - Method in interface org.keycloak.events.admin.AdminEventQuery
Use for pagination
maxResults(int) - Method in interface org.keycloak.events.EventQuery
 
MEMBER - Static variable in class org.keycloak.models.LDAPConstants
 
MEMBER_OF - Static variable in class org.keycloak.models.LDAPConstants
 
methodMatches(Method) - Method in class org.keycloak.models.utils.reflection.AnnotatedPropertyCriteria
 
methodMatches(Method) - Method in class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
methodMatches(Method) - Method in interface org.keycloak.models.utils.reflection.PropertyCriteria
Tests whether the specified method matches the criteria
methodMatches(Method) - Method in class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
MethodProperty<V> - Interface in org.keycloak.models.utils.reflection
 
migrate(KeycloakSession) - Static method in class org.keycloak.migration.MigrationModelManager
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_2_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_3_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_4_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_5_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_6_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_7_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_8_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_9_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo1_9_2
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo2_0_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo2_1_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo2_2_0
 
migrate(KeycloakSession) - Method in class org.keycloak.migration.migrators.MigrateTo2_3_0
 
migrate(KeycloakSession) - Method in interface org.keycloak.migration.migrators.Migration
 
migrateFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
MigrateTo1_2_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_2_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_2_0
 
MigrateTo1_3_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_3_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_3_0
 
MigrateTo1_4_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_4_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_4_0
 
MigrateTo1_5_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_5_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_5_0
 
MigrateTo1_6_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_6_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_6_0
 
MigrateTo1_7_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_7_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_7_0
 
MigrateTo1_8_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_8_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_8_0
 
MigrateTo1_9_0 - Class in org.keycloak.migration.migrators
 
MigrateTo1_9_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_9_0
 
MigrateTo1_9_2 - Class in org.keycloak.migration.migrators
 
MigrateTo1_9_2() - Constructor for class org.keycloak.migration.migrators.MigrateTo1_9_2
 
MigrateTo2_0_0 - Class in org.keycloak.migration.migrators
 
MigrateTo2_0_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo2_0_0
 
MigrateTo2_1_0 - Class in org.keycloak.migration.migrators
 
MigrateTo2_1_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo2_1_0
 
MigrateTo2_2_0 - Class in org.keycloak.migration.migrators
 
MigrateTo2_2_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo2_2_0
 
MigrateTo2_3_0 - Class in org.keycloak.migration.migrators
 
MigrateTo2_3_0() - Constructor for class org.keycloak.migration.migrators.MigrateTo2_3_0
 
Migration - Interface in org.keycloak.migration.migrators
 
MigrationModelManager - Class in org.keycloak.migration
 
MigrationModelManager() - Constructor for class org.keycloak.migration.MigrationModelManager
 
MigrationProvider - Interface in org.keycloak.migration
Various common utils needed for migration from older version to newer
MigrationProviderFactory - Interface in org.keycloak.migration
 
MigrationSpi - Class in org.keycloak.migration
 
MigrationSpi() - Constructor for class org.keycloak.migration.MigrationSpi
 
MigrationUtils - Class in org.keycloak.migration.migrators
 
MigrationUtils() - Constructor for class org.keycloak.migration.migrators.MigrationUtils
 
ModelDuplicateException - Exception in org.keycloak.models
 
ModelDuplicateException() - Constructor for exception org.keycloak.models.ModelDuplicateException
 
ModelDuplicateException(String) - Constructor for exception org.keycloak.models.ModelDuplicateException
 
ModelDuplicateException(String, String) - Constructor for exception org.keycloak.models.ModelDuplicateException
 
ModelDuplicateException(String, Throwable) - Constructor for exception org.keycloak.models.ModelDuplicateException
 
ModelDuplicateException(Throwable) - Constructor for exception org.keycloak.models.ModelDuplicateException
 
ModelException - Exception in org.keycloak.models
 
ModelException() - Constructor for exception org.keycloak.models.ModelException
 
ModelException(String) - Constructor for exception org.keycloak.models.ModelException
 
ModelException(String, Object...) - Constructor for exception org.keycloak.models.ModelException
 
ModelException(String, Throwable) - Constructor for exception org.keycloak.models.ModelException
 
ModelException(Throwable) - Constructor for exception org.keycloak.models.ModelException
 
ModelReadOnlyException - Exception in org.keycloak.models
 
ModelReadOnlyException() - Constructor for exception org.keycloak.models.ModelReadOnlyException
 
ModelReadOnlyException(String) - Constructor for exception org.keycloak.models.ModelReadOnlyException
 
ModelReadOnlyException(String, Throwable) - Constructor for exception org.keycloak.models.ModelReadOnlyException
 
ModelReadOnlyException(Throwable) - Constructor for exception org.keycloak.models.ModelReadOnlyException
 
ModelToRepresentation - Class in org.keycloak.models.utils
 
ModelToRepresentation() - Constructor for class org.keycloak.models.utils.ModelToRepresentation
 
ModelVersion - Class in org.keycloak.migration
 
ModelVersion(int, int, int) - Constructor for class org.keycloak.migration.ModelVersion
 
ModelVersion(String) - Constructor for class org.keycloak.migration.ModelVersion
 
MODIFY_TIMESTAMP - Static variable in class org.keycloak.models.LDAPConstants
 
MSAD_USER_ACCOUNT_CONTROL_MAPPER - Static variable in class org.keycloak.models.LDAPConstants
 

N

NAME - Static variable in class org.keycloak.models.ClaimMask
 
NAME - Static variable in class org.keycloak.models.UserSessionSpi
 
NamedPropertyCriteria - Class in org.keycloak.models.utils.reflection
A criteria that matches a property based on name
NamedPropertyCriteria(String...) - Constructor for class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
nameSet(Theme.Type) - Method in interface org.keycloak.theme.ThemeProvider
 
newEvent() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Create a refresh new EventBuilder to use within this context
newEvent() - Method in interface org.keycloak.authentication.FormContext
Create a refresh new EventBuilder to use within this context
NODE_HOST - Static variable in interface org.keycloak.events.Details
 
NOT_ALLOWED - Static variable in interface org.keycloak.events.Errors
 
notExecuted() - Static method in class org.keycloak.cluster.ExecutionResult
 
notify(String, ClusterEvent, boolean) - Method in interface org.keycloak.cluster.ClusterProvider
Notify registered listeners on all cluster nodes.
notifyCreated(KeycloakSession, RealmModel, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
NotUsernamePasswordPolicyProvider - Class in org.keycloak.policy
 
NotUsernamePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
NotUsernamePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
NotUsernamePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 

O

OBJECT_CLASS - Static variable in class org.keycloak.models.LDAPConstants
 
OBJECT_GUID - Static variable in class org.keycloak.models.LDAPConstants
 
OFFLINE_ACCESS_ROLE - Static variable in interface org.keycloak.models.Constants
 
onClientRemoved(RealmModel, ClientModel) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
onClientRemoved(RealmModel, ClientModel) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
onComplete() - Method in interface org.keycloak.authorization.Decision
 
onComplete() - Method in class org.keycloak.authorization.policy.evaluation.DecisionResultCollector
 
onComplete(List<Result>) - Method in class org.keycloak.authorization.policy.evaluation.DecisionResultCollector
 
onCreate(Policy) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderAdminService
 
onDecision(D) - Method in interface org.keycloak.authorization.Decision
 
onDecision(DefaultEvaluation) - Method in class org.keycloak.authorization.policy.evaluation.DecisionResultCollector
 
onError(Throwable) - Method in interface org.keycloak.authorization.Decision
 
onEvent(Event) - Method in interface org.keycloak.events.EventListenerProvider
 
onEvent(AdminEvent, boolean) - Method in interface org.keycloak.events.EventListenerProvider
 
onProviderModelCreated(RealmModel, UserFederationProviderModel) - Method in class org.keycloak.models.UserFederationEventAwareProviderFactory
 
onRealmRemoved(RealmModel) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
onRealmRemoved(RealmModel) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
onRemove(Policy) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderAdminService
 
onUpdate(Policy) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderAdminService
 
onUserRemoved(RealmModel, UserModel) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
onUserRemoved(RealmModel, UserModel) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
operation(OperationType...) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by operation type
OperationType - Enum in org.keycloak.events.admin
 
org.keycloak - package org.keycloak
 
org.keycloak.authentication - package org.keycloak.authentication
 
org.keycloak.authorization - package org.keycloak.authorization
Fine-grained Authorization SPI.
org.keycloak.authorization.attribute - package org.keycloak.authorization.attribute
Provides classes related with the representation of attributes and their manipulation.
org.keycloak.authorization.identity - package org.keycloak.authorization.identity
Provides classes related with the representation and management of identities.
org.keycloak.authorization.model - package org.keycloak.authorization.model
Provides the domain model and any other type related with it
org.keycloak.authorization.permission - package org.keycloak.authorization.permission
 
org.keycloak.authorization.permission.evaluator - package org.keycloak.authorization.permission.evaluator
 
org.keycloak.authorization.policy.evaluation - package org.keycloak.authorization.policy.evaluation
Provides classes related with the evaluation of policies.
org.keycloak.authorization.policy.provider - package org.keycloak.authorization.policy.provider
Provides classes and a SPI to plug different policy providers.
org.keycloak.authorization.store - package org.keycloak.authorization.store
Provides classes and a SPI to plug different metadata storage implementations.
org.keycloak.authorization.store.syncronization - package org.keycloak.authorization.store.syncronization
 
org.keycloak.broker.provider - package org.keycloak.broker.provider
 
org.keycloak.broker.provider.util - package org.keycloak.broker.provider.util
 
org.keycloak.broker.social - package org.keycloak.broker.social
 
org.keycloak.cluster - package org.keycloak.cluster
 
org.keycloak.connections.httpclient - package org.keycloak.connections.httpclient
 
org.keycloak.credential - package org.keycloak.credential
 
org.keycloak.credential.hash - package org.keycloak.credential.hash
 
org.keycloak.email - package org.keycloak.email
 
org.keycloak.events - package org.keycloak.events
 
org.keycloak.events.admin - package org.keycloak.events.admin
 
org.keycloak.exportimport - package org.keycloak.exportimport
 
org.keycloak.forms.account - package org.keycloak.forms.account
 
org.keycloak.forms.login - package org.keycloak.forms.login
 
org.keycloak.keys - package org.keycloak.keys
 
org.keycloak.mappers - package org.keycloak.mappers
 
org.keycloak.migration - package org.keycloak.migration
 
org.keycloak.migration.migrators - package org.keycloak.migration.migrators
 
org.keycloak.models - package org.keycloak.models
 
org.keycloak.models.cache - package org.keycloak.models.cache
 
org.keycloak.models.cache.authorization - package org.keycloak.models.cache.authorization
 
org.keycloak.models.dblock - package org.keycloak.models.dblock
 
org.keycloak.models.session - package org.keycloak.models.session
 
org.keycloak.models.utils - package org.keycloak.models.utils
 
org.keycloak.models.utils.reflection - package org.keycloak.models.utils.reflection
 
org.keycloak.policy - package org.keycloak.policy
 
org.keycloak.protocol - package org.keycloak.protocol
 
org.keycloak.protocol.oidc - package org.keycloak.protocol.oidc
 
org.keycloak.provider - package org.keycloak.provider
 
org.keycloak.scripting - package org.keycloak.scripting
 
org.keycloak.services.managers - package org.keycloak.services.managers
 
org.keycloak.services.resource - package org.keycloak.services.resource
 
org.keycloak.theme - package org.keycloak.theme
 
org.keycloak.timer - package org.keycloak.timer
 
org.keycloak.transaction - package org.keycloak.transaction
 
org.keycloak.truststore - package org.keycloak.truststore
 

P

PAGINATION - Static variable in class org.keycloak.models.LDAPConstants
 
param(String, String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
parse(String, KeycloakSession, RealmModel) - Static method in class org.keycloak.services.managers.ClientSessionCode
 
parseConfig(KeycloakSession, InputStream) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
parseConfig(KeycloakSession, InputStream) - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates an IdentityProvider based on the configuration from inputStream.
parseConfig(String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
parseResult(String, KeycloakSession, RealmModel) - Static method in class org.keycloak.services.managers.ClientSessionCode
 
ParseResult() - Constructor for class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
parseRole(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
PASSWORD_CONFIRM_ERROR - Static variable in interface org.keycloak.events.Errors
 
PASSWORD_MISSING - Static variable in interface org.keycloak.events.Errors
 
PASSWORD_REJECTED - Static variable in interface org.keycloak.events.Errors
 
PasswordHashProviderFactory - Interface in org.keycloak.credential.hash
 
PasswordHashSpi - Class in org.keycloak.credential.hash
 
PasswordHashSpi() - Constructor for class org.keycloak.credential.hash.PasswordHashSpi
 
PasswordPolicyManagerProvider - Interface in org.keycloak.policy
 
PasswordPolicyManagerProviderFactory - Interface in org.keycloak.policy
 
PasswordPolicyManagerSpi - Class in org.keycloak.policy
 
PasswordPolicyManagerSpi() - Constructor for class org.keycloak.policy.PasswordPolicyManagerSpi
 
PasswordPolicyProviderFactory - Interface in org.keycloak.policy
 
PasswordPolicySpi - Class in org.keycloak.policy
 
PasswordPolicySpi() - Constructor for class org.keycloak.policy.PasswordPolicySpi
 
Pbkdf2PasswordHashProvider - Class in org.keycloak.credential.hash
 
Pbkdf2PasswordHashProvider() - Constructor for class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
performLogin(AuthenticationRequest) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
performLogin(AuthenticationRequest) - Method in interface org.keycloak.broker.provider.IdentityProvider
Initiates the authentication process by sending an authentication request to an identity provider.
PermissionEvaluator - Interface in org.keycloak.authorization.permission.evaluator
An PermissionEvaluator represents a source of ResourcePermission, responsible for emitting these permissions to a consumer in order to evaluate the authorization policies based on a EvaluationContext.
PersistentClientSessionAdapter - Class in org.keycloak.models.session
 
PersistentClientSessionAdapter(ClientSessionModel) - Constructor for class org.keycloak.models.session.PersistentClientSessionAdapter
 
PersistentClientSessionAdapter(PersistentClientSessionModel, RealmModel, ClientModel, UserSessionModel) - Constructor for class org.keycloak.models.session.PersistentClientSessionAdapter
 
PersistentClientSessionAdapter.PersistentClientSessionData - Class in org.keycloak.models.session
 
PersistentClientSessionData() - Constructor for class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
PersistentClientSessionModel - Class in org.keycloak.models.session
 
PersistentClientSessionModel() - Constructor for class org.keycloak.models.session.PersistentClientSessionModel
 
PersistentUserSessionAdapter - Class in org.keycloak.models.session
 
PersistentUserSessionAdapter(UserSessionModel) - Constructor for class org.keycloak.models.session.PersistentUserSessionAdapter
 
PersistentUserSessionAdapter(PersistentUserSessionModel, RealmModel, UserModel, List<ClientSessionModel>) - Constructor for class org.keycloak.models.session.PersistentUserSessionAdapter
 
PersistentUserSessionAdapter.PersistentUserSessionData - Class in org.keycloak.models.session
 
PersistentUserSessionData() - Constructor for class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
PersistentUserSessionModel - Class in org.keycloak.models.session
 
PersistentUserSessionModel() - Constructor for class org.keycloak.models.session.PersistentUserSessionModel
 
PHONE - Static variable in class org.keycloak.models.ClaimMask
 
PICTURE - Static variable in class org.keycloak.models.ClaimMask
 
Policy - Interface in org.keycloak.authorization.model
Represents an authorization policy and all the configuration associated with it.
policy(Policy) - Method in class org.keycloak.authorization.policy.evaluation.Result
 
policy(Policy) - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
policyCheck(PasswordPolicy, CredentialModel) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
PolicyEvaluator - Interface in org.keycloak.authorization.policy.evaluation
A PolicyEvaluator evaluates authorization policies based on a given ResourcePermission, sending the results to a Decision point through the methods defined in that interface.
PolicyProvider - Interface in org.keycloak.authorization.policy.provider
 
PolicyProviderAdminService - Interface in org.keycloak.authorization.policy.provider
 
PolicyProviderFactory - Interface in org.keycloak.authorization.policy.provider
 
PolicyResult(Policy) - Constructor for class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
PolicySpi - Class in org.keycloak.authorization.policy.provider
 
PolicySpi() - Constructor for class org.keycloak.authorization.policy.provider.PolicySpi
 
PolicyStore - Interface in org.keycloak.authorization.store
A PolicyStore is responsible to manage the persistence of Policy instances.
POSTAL_CODE - Static variable in class org.keycloak.models.LDAPConstants
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.AuthorizationStoreFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.credential.CredentialProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.models.session.UserSessionPersisterProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.UserFederationEventAwareProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
PostMigrationEvent - Class in org.keycloak.models.utils
Executed at startup after model migration is finished
PostMigrationEvent() - Constructor for class org.keycloak.models.utils.PostMigrationEvent
 
postText(String, String) - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
Helper method
prepareInvocableScript(ScriptModel, ScriptBindingsConfigurer) - Method in interface org.keycloak.scripting.ScriptingProvider
Returns an InvocableScriptAdapter based on the given ScriptModel.
preprocessFederatedIdentity(KeycloakSession, RealmModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
preprocessFederatedIdentity(KeycloakSession, RealmModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
preprocessFederatedIdentity(KeycloakSession, RealmModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
preprocessFederatedIdentity(KeycloakSession, RealmModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
Called to determine what keycloak username and email to use to process the login request from the external IDP.
PREVIOUS_EMAIL - Static variable in interface org.keycloak.events.Details
 
processAction(String) - Method in interface org.keycloak.authentication.AuthenticationFlow
 
processAction(RequiredActionContext) - Method in interface org.keycloak.authentication.RequiredActionProvider
Called when a required action has form input you want to process.
processFlow() - Method in interface org.keycloak.authentication.AuthenticationFlow
 
PROFILE - Static variable in class org.keycloak.models.ClaimMask
 
Properties - Class in org.keycloak.models.utils.reflection
Utility class for working with JavaBean style properties
Property<V> - Interface in org.keycloak.models.utils.reflection
A representation of a JavaBean style property
PropertyCriteria - Interface in org.keycloak.models.utils.reflection
A property criteria can be used to filter the properties found by a PropertyQuery
PropertyQueries - Class in org.keycloak.models.utils.reflection
Utilities for working with property queries
PropertyQuery<V> - Class in org.keycloak.models.utils.reflection
Queries a target class for properties that match certain criteria.
ProtocolMapper - Interface in org.keycloak.protocol
 
ProtocolMapperConfigException - Exception in org.keycloak.protocol
 
ProtocolMapperConfigException(String) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, Throwable) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String, Throwable) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, Object...) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String, Object...) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperSpi - Class in org.keycloak.protocol
 
ProtocolMapperSpi() - Constructor for class org.keycloak.protocol.ProtocolMapperSpi
 
ProviderLoader - Interface in org.keycloak.provider
 
ProviderLoaderFactory - Interface in org.keycloak.provider
 
PublicKeyLoader - Interface in org.keycloak.keys
 
PublicKeyStorageProvider - Interface in org.keycloak.keys
 
PublicKeyStorageProviderFactory - Interface in org.keycloak.keys
 
PublicKeyStorageSpi - Class in org.keycloak.keys
 
PublicKeyStorageSpi() - Constructor for class org.keycloak.keys.PublicKeyStorageSpi
 
PWD_LAST_SET - Static variable in class org.keycloak.models.LDAPConstants
 

R

RDN_LDAP_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 
READ_TOKEN_ROLE - Static variable in interface org.keycloak.models.Constants
 
realm(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by resource realm
realm(RealmModel) - Method in class org.keycloak.events.EventBuilder
 
realm(String) - Method in class org.keycloak.events.EventBuilder
 
realm(String) - Method in interface org.keycloak.events.EventQuery
 
REALM_ADMIN - Static variable in class org.keycloak.models.AdminRoles
 
REALM_DISABLED - Static variable in interface org.keycloak.events.Errors
 
REALM_MANAGEMENT_CLIENT_ID - Static variable in interface org.keycloak.models.Constants
 
RealmImporter - Interface in org.keycloak.models.utils
Helper interface used just because RealmManager is in keycloak-services and not accessible for ImportUtils
RealmInfoUtil - Class in org.keycloak.models.utils
 
RealmInfoUtil() - Constructor for class org.keycloak.models.utils.RealmInfoUtil
 
RealmProviderFactory - Interface in org.keycloak.models
 
RealmResourceProvider - Interface in org.keycloak.services.resource
A RealmResourceProvider creates JAX-RS sub-resource instances for paths relative to Realm's RESTful API that could not be resolved by the server.
RealmResourceProviderFactory - Interface in org.keycloak.services.resource
A factory that creates RealmResourceProvider instances.
RealmResourceSPI - Class in org.keycloak.services.resource
A Spi to plug additional sub-resources to Realms' RESTful API.
RealmResourceSPI() - Constructor for class org.keycloak.services.resource.RealmResourceSPI
 
RealmSpi - Class in org.keycloak.models
 
RealmSpi() - Constructor for class org.keycloak.models.RealmSpi
 
RealmSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
RealmSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.RealmSynchronizer
 
REASON - Static variable in interface org.keycloak.events.Details
 
REDIRECT_URI - Static variable in interface org.keycloak.events.Details
 
REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
REFRESH_TOKEN_TYPE - Static variable in interface org.keycloak.events.Details
 
RegexPatternsPasswordPolicyProvider - Class in org.keycloak.policy
 
RegexPatternsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
RegexPatternsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
RegexPatternsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
REGISTER_METHOD - Static variable in interface org.keycloak.events.Details
 
registerClientInvalidation(String, String, String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerClientTemplateInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerGroupInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerListener(String, ClusterListener) - Method in interface org.keycloak.cluster.ClusterProvider
Register task (listener) under given key.
registerRealmInvalidation(String, String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerRoleInvalidation(String, String, String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerSynchronizationListeners(KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.AuthorizationStoreFactory
 
REGISTRATION_DISABLED - Static variable in interface org.keycloak.events.Errors
 
REGISTRATION_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
REGISTRATION_FORM_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
registrationFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
REJECTED_BY_USER - Static variable in interface org.keycloak.events.Errors
 
releaseLock() - Method in interface org.keycloak.models.dblock.DBLockProvider
Release previously acquired lock
REMEMBER_ME - Static variable in interface org.keycloak.events.Details
 
removeAssociatedPolicy(Policy) - Method in interface org.keycloak.authorization.model.Policy
 
removeAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeClientSession(String, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
removeClientSession(String, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
removeDetail(String) - Method in class org.keycloak.events.EventBuilder
 
removeNote(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeNote(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
removeRequiredAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
removeScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
removeUserSession(String, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
removeUserSession(String, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
renameRealm(RealmModel, String) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
render(FormContext, LoginFormsProvider) - Method in interface org.keycloak.authentication.FormAuthenticator
Called to render the FormAuthenticator's challenge page.
RepresentationToModel - Class in org.keycloak.models.utils
 
RepresentationToModel() - Constructor for class org.keycloak.models.utils.RepresentationToModel
 
requiredActionChallenge(RequiredActionContext) - Method in interface org.keycloak.authentication.RequiredActionProvider
If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser.
RequiredActionContext - Interface in org.keycloak.authentication
Interface that encapsulates current information about the current requred action
RequiredActionContext.Status - Enum in org.keycloak.authentication
 
RequiredActionFactory - Interface in org.keycloak.authentication
You must specify a file META-INF/services/org.keycloak.authentication.RequiredActionFactory in the jar that this class is contained in This file must have the fully qualified class name of all your RequiredActionFactory classes
RequiredActionProvider - Interface in org.keycloak.authentication
RequiredAction provider.
RequiredActionSpi - Class in org.keycloak.authentication
 
RequiredActionSpi() - Constructor for class org.keycloak.authentication.RequiredActionSpi
 
requireReauthentication(UserSessionModel, ClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
requiresUser() - Method in interface org.keycloak.authentication.Authenticator
Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
requiresUser() - Method in interface org.keycloak.authentication.FormAction
Does this FormAction require that a user be set? For registration, this method will always return false.
RESET_CREDENTIAL_DISABLED - Static variable in interface org.keycloak.events.Errors
 
RESET_CREDENTIALS_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
resetCredentialsFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
resetFlow() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Reset the current flow to the beginning and restarts it.
RESOLVE_REQUIRED_ACTIONS - Static variable in interface org.keycloak.events.Errors
 
resolveAttribute(String) - Method in class org.keycloak.models.ClientConfigResolver
 
resolveAttribute(GroupModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolveAttribute(UserModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolveFirstAttribute(GroupModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolveFirstAttribute(UserModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
Resource - Interface in org.keycloak.authorization.model
Represents a resource, which is usually protected by a set of policies within a resource server.
resourcePath(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by resource path.
ResourcePermission - Class in org.keycloak.authorization.permission
Represents a permission for a given resource.
ResourcePermission(Resource, List<Scope>, ResourceServer) - Constructor for class org.keycloak.authorization.permission.ResourcePermission
 
ResourceServer - Interface in org.keycloak.authorization.model
Represents a resource server, whose resources are managed and protected.
ResourceServerStore - Interface in org.keycloak.authorization.store
A ResourceServerStore is responsible to manage the persistence of ResourceServer instances.
ResourceStore - Interface in org.keycloak.authorization.store
A ResourceStore is responsible to manage the persistence of Resource instances.
resourceType(ResourceType...) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by ResourceType.
ResourceType - Enum in org.keycloak.events.admin
Represents Keycloak resource types for which AdminEvent's can be triggered.
RESPONSE_MODE - Static variable in interface org.keycloak.events.Details
 
RESPONSE_TYPE - Static variable in interface org.keycloak.events.Details
 
RESTART_AFTER_TIMEOUT - Static variable in interface org.keycloak.events.Details
 
Result - Class in org.keycloak.authorization.policy.evaluation
 
Result(ResourcePermission) - Constructor for class org.keycloak.authorization.policy.evaluation.Result
 
Result.PolicyResult - Class in org.keycloak.authorization.policy.evaluation
 
retrieveToken(KeycloakSession, FederatedIdentityModel) - Method in interface org.keycloak.broker.provider.IdentityProvider
Returns a Response containing the token previously stored during the authentication process for a specific user.
REVOKED_CLIENT - Static variable in interface org.keycloak.events.Details
 
ROLE - Static variable in interface org.keycloak.broker.provider.ConfigConstants
 
run(KeycloakSession) - Method in interface org.keycloak.timer.ScheduledTask
 
runJobInTransaction(KeycloakSessionFactory, KeycloakSessionTask) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Wrap given runnable job into KeycloakTransaction.

S

SAM_ACCOUNT_NAME - Static variable in class org.keycloak.models.LDAPConstants
 
SAML_ECP_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
samlEcpProfile(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
schedule(List<ResourcePermission>, EvaluationContext) - Method in class org.keycloak.authorization.permission.evaluator.Evaluators
 
schedule(Runnable, long, String) - Method in interface org.keycloak.timer.TimerProvider
 
ScheduledTask - Interface in org.keycloak.timer
 
scheduleTask(ScheduledTask, long, String) - Method in interface org.keycloak.timer.TimerProvider
 
Scope - Interface in org.keycloak.authorization.model
Represents a scope, which is usually associated with one or more resources in order to define the actions that can be performed or a specific access context.
ScopeStore - Interface in org.keycloak.authorization.store
A ScopeStore is responsible to manage the persistence of Scope instances.
Script - Class in org.keycloak.scripting
A ScriptModel which holds some meta-data.
Script(String, String, String, String, String, String) - Constructor for class org.keycloak.scripting.Script
 
ScriptBindingsConfigurer - Interface in org.keycloak.scripting
Callback interface for customization of Bindings for a ScriptEngine.
ScriptExecutionException - Exception in org.keycloak.scripting
Augments a ScriptException and adds additional metadata.
ScriptExecutionException(ScriptModel, Exception) - Constructor for exception org.keycloak.scripting.ScriptExecutionException
 
ScriptingProvider - Interface in org.keycloak.scripting
A Provider than provides Scripting capabilities.
ScriptingProviderFactory - Interface in org.keycloak.scripting
 
ScriptingSpi - Class in org.keycloak.scripting
 
ScriptingSpi() - Constructor for class org.keycloak.scripting.ScriptingSpi
 
SEARCH_SCOPE - Static variable in class org.keycloak.models.LDAPConstants
 
searchFor(RoleModel, RoleModel, Set<RoleModel>) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Deep search if given role is descendant of composite role
send(RealmModel, UserModel, String, String, String) - Method in interface org.keycloak.email.EmailSenderProvider
 
sendConfirmIdentityBrokerLink(String, long) - Method in interface org.keycloak.email.EmailTemplateProvider
Send to confirm that user wants to link his account with identity broker link
sendError(ClientSessionModel, LoginProtocol.Error) - Method in interface org.keycloak.protocol.LoginProtocol
 
sendEvent(Event) - Method in interface org.keycloak.email.EmailTemplateProvider
 
sendExecuteActions(String, long) - Method in interface org.keycloak.email.EmailTemplateProvider
Change password email requested by admin
sendPasswordReset(String, long) - Method in interface org.keycloak.email.EmailTemplateProvider
Reset password sent from forgot password link on login
sendVerifyEmail(String, long) - Method in interface org.keycloak.email.EmailTemplateProvider
 
serialize(Object) - Method in class org.keycloak.broker.provider.DefaultDataMarshaller
 
serialize(Object) - Method in interface org.keycloak.broker.provider.IdentityProviderDataMarshaller
 
ServerInfoAwareProviderFactory - Interface in org.keycloak.provider
Marker interface for ProviderFactory of Provider which wants to show some info on "Server Info" page in Admin console.
ServerStartupError - Error in org.keycloak
Non-recoverable error thrown during server startup
ServerStartupError(String) - Constructor for error org.keycloak.ServerStartupError
 
ServerStartupError(String, boolean) - Constructor for error org.keycloak.ServerStartupError
 
session - Variable in class org.keycloak.broker.provider.AbstractIdentityProvider
 
session(UserSessionModel) - Method in class org.keycloak.events.EventBuilder
 
session(String) - Method in class org.keycloak.events.EventBuilder
 
SESSION_EXPIRED - Static variable in interface org.keycloak.events.Errors
 
setAccessible() - Method in interface org.keycloak.models.utils.reflection.Property
Calls the setAccessible method on the underlying member(s).
setAccessRequest(List<RoleModel>, MultivaluedMap<String, RoleModel>, List<ProtocolMapperModel>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAccessRequest(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setAction(String) - Method in class org.keycloak.services.managers.ClientSessionCode
 
setActionUri(URI) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAllowRemoteResourceManagement(boolean) - Method in interface org.keycloak.authorization.model.ResourceServer
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.
setAttribute(String, Object) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setAttribute(String, Object) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAttribute(String, List<String>) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setAuthDetails(AuthDetails) - Method in class org.keycloak.events.admin.AdminEvent
 
setAuthenticatedUser(UserModel) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setAuthMethod(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setAuthMethod(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setAuthMethod(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setBrokerSessionId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setBrokerSessionId(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setBrokerUserId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setBrokerUserId(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setCalendar(Calendar) - Method in class org.keycloak.models.utils.TimeBasedOTP
 
setClient(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Attach a specific client to this flow.
setClientId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setClientId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setClientId(String) - Method in class org.keycloak.events.Event
 
setClientId(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setClientSession(ClientSessionModel) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setClientSession(ClientSessionModel) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setClientSessionCode(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setClientSessionId(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setCode(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCode(String) - Method in class org.keycloak.scripting.Script
 
setConfig(Map<String, String>) - Method in interface org.keycloak.authorization.model.Policy
Sets a Map with string-based key/value pairs representing any additional configuration for this policy.
setContextData(Map<String, Object>) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCreatedTimestamp(Long) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setData(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setData(String) - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
setDecisionStrategy(DecisionStrategy) - Method in interface org.keycloak.authorization.model.Policy
Sets the {DecisionStrategy} for this policy.
setDescription(String) - Method in interface org.keycloak.authorization.model.Policy
Sets the description for this policy.
setDescription(String) - Method in class org.keycloak.scripting.Script
 
setDetails(Map<String, String>) - Method in class org.keycloak.events.Event
 
setEmail(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setEmail(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setEmailVerified(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setEnabled(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setError(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setError(String) - Method in class org.keycloak.events.Event
 
setError(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setError(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
Set one global error message.
setErrors(List<FormMessage>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setErrors(List<FormMessage>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
Set multiple error messages.
setEventBuilder(EventBuilder) - Method in interface org.keycloak.protocol.LoginProtocol
 
setEvents(List<Event>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setExecutionStatus(Map<String, ClientSessionModel.ExecutionStatus>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setExecutionStatus(String, ClientSessionModel.ExecutionStatus) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setFeatures(boolean, boolean, boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setFederationLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setFirstName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setFirstName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setHttpHeaders(HttpHeaders) - Method in interface org.keycloak.forms.account.AccountProvider
 
setHttpHeaders(HttpHeaders) - Method in interface org.keycloak.protocol.LoginProtocol
 
setIconUri(String) - Method in interface org.keycloak.authorization.model.Resource
Sets an icon URI for this resource.
setIconUri(String) - Method in interface org.keycloak.authorization.model.Scope
Sets an icon URI for this scope.
setId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setId(String) - Method in class org.keycloak.scripting.Script
 
setIdp(IdentityProvider) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setIdpConfig(IdentityProviderModel) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setInfo(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setIpAddress(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setIpAddress(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setIpAddress(String) - Method in class org.keycloak.events.Event
 
setIpAddress(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setLastName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setLastName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setLastSessionRefresh(int) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
setLastSessionRefresh(int) - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
setLogic(Logic) - Method in interface org.keycloak.authorization.model.Policy
Sets the {Logic} for this policy.
setMimeType(String) - Method in class org.keycloak.scripting.Script
 
setModelUsername(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setName(String) - Method in interface org.keycloak.authorization.model.Policy
Sets an unique name to this policy.
setName(String) - Method in interface org.keycloak.authorization.model.Resource
Sets a name for this resource.
setName(String) - Method in interface org.keycloak.authorization.model.Scope
Sets a name for this scope.
setName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setName(String) - Method in class org.keycloak.scripting.Script
 
setNote(String, String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setNote(String, String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
setNotes(Map<String, String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setNotes(Map<String, String>) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setOperationType(OperationType) - Method in class org.keycloak.events.admin.AdminEvent
 
setParameters(Object[]) - Method in exception org.keycloak.mappers.FederationConfigValidationException
 
setParameters(Object[]) - Method in exception org.keycloak.models.ModelException
 
setParameters(Object[]) - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
setPasswordSet(boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setPolicyEnforcementMode(PolicyEnforcementMode) - Method in interface org.keycloak.authorization.model.ResourceServer
Defines a PolicyEnforcementMode for this instance.
setProfileFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setProtocolMappers(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setProtocolMappers(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setRealm(RealmModel) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setRealm(RealmModel) - Method in interface org.keycloak.forms.account.AccountProvider
 
setRealm(RealmModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
setRealmId(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setRealmId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setRealmId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setRealmId(String) - Method in class org.keycloak.events.Event
 
setRealmId(String) - Method in class org.keycloak.scripting.Script
 
setRedirectUri(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setRedirectUri(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setReferrer(String[]) - Method in interface org.keycloak.forms.account.AccountProvider
 
setRememberMe(boolean) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setRepresentation(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setRequiredActions(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.Authenticator
Set actions to configure authenticator
setRequiredActions(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.FormAction
Set actions to configure authenticator
setRequiredActions(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setResourcePath(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setResourceType(ResourceType) - Method in class org.keycloak.events.admin.AdminEvent
 
setResponseHeader(String, String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setRoles(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setRoles(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setServiceAccountClientLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setSession(KeycloakSession) - Method in interface org.keycloak.protocol.LoginProtocol
 
setSessionId(String) - Method in class org.keycloak.events.Event
 
setSessions(List<UserSessionModel>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setSingleAttribute(String, String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setStarted(int) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setState(UserSessionModel.State) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setState(UserSessionModel.State) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
setStateChecker(String) - Method in interface org.keycloak.forms.account.AccountProvider
 
setStatus(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
setStatus(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result
 
setStatus(Response.Status) - Method in interface org.keycloak.forms.account.AccountProvider
 
setStatus(Response.Status) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setTime(long) - Method in class org.keycloak.events.admin.AdminEvent
 
setTime(long) - Method in class org.keycloak.events.Event
 
setTimeouts(long, long) - Method in interface org.keycloak.models.dblock.DBLockProviderFactory
Useful for testing to override provided configuration
setTimestamp(int) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setTimestamp(int) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setToken(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setTruststoreSpiIfNeeded(String, String, Map<String, Object>) - Static method in class org.keycloak.models.LDAPConstants
 
setType(String) - Method in interface org.keycloak.authorization.model.Resource
Sets a string representing the type of this resource.
setType(EventType) - Method in class org.keycloak.events.Event
 
setupAdminCli(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
 
setupAuthorizationServices(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
setupBrokerService(RealmModel) - Method in class org.keycloak.migration.migrators.MigrateTo1_2_0
 
setupClientDefaults(ClientRepresentation, ClientModel) - Method in interface org.keycloak.protocol.LoginProtocolFactory
Setup default values for new clients.
setupImpersonationService(KeycloakSession, RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setupMasterRealmRole(RealmProvider, RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setupOfflineTokens(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
setupRealmRole(RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setupTemplateDefaults(ClientTemplateRepresentation, ClientTemplateModel) - Method in interface org.keycloak.protocol.LoginProtocolFactory
Setup default values for new templates.
setUri(String) - Method in interface org.keycloak.authorization.model.Resource
Sets a URI that uniquely identify this resource.
setUriInfo(UriInfo) - Method in interface org.keycloak.forms.account.AccountProvider
 
setUriInfo(UriInfo) - Method in interface org.keycloak.protocol.LoginProtocol
 
setUser(UserModel) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Attach a specific user to this flow.
setUser(UserModel) - Method in interface org.keycloak.authentication.FormContext
Attach a specific user to this flow.
setUser(UserModel) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setUser(UserModel) - Method in interface org.keycloak.forms.account.AccountProvider
 
setUser(UserModel) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setUserAttribute(String, String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUserId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setUserId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setUserId(String) - Method in class org.keycloak.events.Event
 
setUserId(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setUsername(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUsername(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setUserSession(UserSessionModel) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setUserSessionId(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setUserSessionId(String) - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
setUserSessionNote(String, String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setUserSessionNotes(Map<String, String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setValue(Object, V) - Method in interface org.keycloak.models.utils.reflection.Property
This method sets the property value for a specified bean to the specified value.
setWarning(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
SHAPasswordEncoder - Class in org.keycloak.models.utils
Password that uses SHA to encode passwords.
SHAPasswordEncoder(int) - Constructor for class org.keycloak.models.utils.SHAPasswordEncoder
 
SIGNATURE_ALGORITHM - Static variable in interface org.keycloak.events.Details
 
SIGNATURE_REQUIRED - Static variable in interface org.keycloak.events.Details
 
SimpleHttp - Class in org.keycloak.broker.provider.util
 
SimpleHttp(String, String) - Constructor for class org.keycloak.broker.provider.util.SimpleHttp
 
size() - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
SN - Static variable in class org.keycloak.models.LDAPConstants
 
SOCIAL_SPI_NAME - Static variable in class org.keycloak.broker.social.SocialProviderSpi
 
SocialIdentityProvider<C extends IdentityProviderModel> - Interface in org.keycloak.broker.social
 
SocialIdentityProviderFactory<I extends SocialIdentityProvider> - Interface in org.keycloak.broker.social
 
SocialProviderSpi - Class in org.keycloak.broker.social
 
SocialProviderSpi() - Constructor for class org.keycloak.broker.social.SocialProviderSpi
 
SpecialCharsPasswordPolicyProvider - Class in org.keycloak.policy
 
SpecialCharsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
SpecialCharsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
SpecialCharsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
SSL_REQUIRED - Static variable in interface org.keycloak.events.Errors
 
sslFactory(SSLSocketFactory) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
status(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
StoreFactory - Interface in org.keycloak.authorization.store
A factory for the different types of storages that manage the persistence of the domain model types.
StoreFactorySpi - Class in org.keycloak.authorization.store
 
StoreFactorySpi() - Constructor for class org.keycloak.authorization.store.StoreFactorySpi
 
Strategy - Enum in org.keycloak.exportimport
 
STREET - Static variable in class org.keycloak.models.LDAPConstants
 
strip(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(RealmRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(IdentityProviderRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
StripSecretsUtils - Class in org.keycloak.models.utils
 
StripSecretsUtils() - Constructor for class org.keycloak.models.utils.StripSecretsUtils
 
success() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Mark the current execution as successful.
success(FormContext) - Method in interface org.keycloak.authentication.FormAction
Called after all validate() calls of all FormAction providers are successful.
success() - Method in interface org.keycloak.authentication.RequiredActionContext
Mark this required action as successful.
success() - Method in interface org.keycloak.authentication.ValidationContext
Mark this validation as sucessful
success() - Method in class org.keycloak.events.EventBuilder
 
successMessage - Variable in exception org.keycloak.authentication.ForkFlowException
 
supports(String) - Method in interface org.keycloak.provider.ProviderLoaderFactory
 
supportsForcedUnlock() - Method in interface org.keycloak.models.dblock.DBLockProvider
 
suspendJtaTransaction(KeycloakSessionFactory, Runnable) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
SYNC_REGISTRATIONS - Static variable in class org.keycloak.models.LDAPConstants
 
syncDataFromFederationProviderToKeycloak(UserFederationMapperModel, UserFederationProvider, KeycloakSession, RealmModel) - Method in interface org.keycloak.mappers.UserFederationMapper
Sync data from federated storage to Keycloak.
syncDataFromKeycloakToFederationProvider(UserFederationMapperModel, UserFederationProvider, KeycloakSession, RealmModel) - Method in interface org.keycloak.mappers.UserFederationMapper
Sync data from Keycloak back to federated storage
synchronize(RealmModel.ClientRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.ClientApplicationSynchronizer
 
synchronize(RealmModel.RealmRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.RealmSynchronizer
 
synchronize(E, KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.syncronization.Synchronizer
 
synchronize(UserModel.UserRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.UserSynchronizer
 
Synchronizer<E extends ProviderEvent> - Interface in org.keycloak.authorization.store.syncronization
 

T

Theme - Interface in org.keycloak.theme
 
Theme.Type - Enum in org.keycloak.theme
 
ThemeProvider - Interface in org.keycloak.theme
 
ThemeProviderFactory - Interface in org.keycloak.theme
 
ThemeSpi - Class in org.keycloak.theme
 
ThemeSpi() - Constructor for class org.keycloak.theme.ThemeSpi
 
TimeBasedOTP - Class in org.keycloak.models.utils
TOTP: Time-based One-time Password Algorithm Based on http://tools.ietf.org/html/draft-mraihi-totp-timebased-06
TimeBasedOTP() - Constructor for class org.keycloak.models.utils.TimeBasedOTP
 
TimeBasedOTP(String, int, int, int) - Constructor for class org.keycloak.models.utils.TimeBasedOTP
 
TimerProvider - Interface in org.keycloak.timer
 
TimerProviderFactory - Interface in org.keycloak.timer
 
TimerSpi - Class in org.keycloak.timer
 
TimerSpi() - Constructor for class org.keycloak.timer.TimerSpi
 
toDate(Date) - Method in interface org.keycloak.events.EventQuery
 
toEventsConfigReprensetation(RealmModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(RealmModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(GroupModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
TokenIntrospectionProvider - Interface in org.keycloak.protocol.oidc
Provides introspection for a determined OAuth2 token type.
TokenIntrospectionProviderFactory - Interface in org.keycloak.protocol.oidc
A factory that creates TokenIntrospectionProvider instances.
TokenIntrospectionSpi - Class in org.keycloak.protocol.oidc
A Spi to support additional tokens types to the OAuth2 Token Introspection Endpoint.
TokenIntrospectionSpi() - Constructor for class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
toLowerCaseSafe(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
toMap() - Method in interface org.keycloak.authorization.attribute.Attributes
Converts to a Map.
toModel(RealmModel, UserFederationMapperRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(CredentialRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, IdentityProviderRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ProtocolMapperRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(IdentityProviderMapperRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, UserConsentRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(AuthenticationFlowRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, AuthenticationExecutionExportRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, AuthenticationExecutionRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(AuthenticatorConfigRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RequiredActionProviderRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ResourceServerRepresentation, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(PolicyRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ResourceRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ScopeRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toPolicy(RealmRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toRepresentation(GroupModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(KeycloakSession, RealmModel, UserModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Event) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(AdminEvent) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(AuthDetails) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RoleModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserCredentialModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(FederatedIdentityModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserSessionModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ClientTemplateModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ClientModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserFederationProviderModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, UserFederationMapperModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, IdentityProviderModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ProtocolMapperModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(IdentityProviderMapperModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserConsentModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, AuthenticationFlowModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, AuthenticationExecutionModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(AuthenticatorConfigModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RequiredActionProviderModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(List<ProviderConfigProperty>) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ProviderConfigProperty) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(KeycloakSession, ComponentModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Scope, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ResourceServer, ClientModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Policy, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Resource, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toString() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
toString() - Method in class org.keycloak.migration.ModelVersion
 
toString() - Method in class org.keycloak.models.utils.FormMessage
 
toString() - Method in class org.keycloak.scripting.Script
 
toTime(Date) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by events before the specified time
TransactionManagerLookupSpi - Class in org.keycloak.transaction
 
TransactionManagerLookupSpi() - Constructor for class org.keycloak.transaction.TransactionManagerLookupSpi
 
TruststoreProvider - Interface in org.keycloak.truststore
 
TruststoreProviderFactory - Interface in org.keycloak.truststore
 
TruststoreSpi - Class in org.keycloak.truststore
 
TruststoreSpi() - Constructor for class org.keycloak.truststore.TruststoreSpi
 
type(EventType...) - Method in interface org.keycloak.events.EventQuery
 
TypedPropertyCriteria - Class in org.keycloak.models.utils.reflection
A criteria that matches a property based on its type
TypedPropertyCriteria(Class<?>) - Constructor for class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
TypedPropertyCriteria(Class<?>, TypedPropertyCriteria.MatchOption) - Constructor for class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
TypedPropertyCriteria.MatchOption - Enum in org.keycloak.models.utils.reflection
Different options can be used to match a specific property based on its type.

U

UID - Static variable in class org.keycloak.models.LDAPConstants
 
UPDATE_PROFILE_CONTEXT_ATTR - Static variable in interface org.keycloak.forms.login.LoginFormsProvider
 
updateAllTimestamps(int) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
updateAllTimestamps(int) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
updateBrokeredUser(KeycloakSession, RealmModel, UserModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
updateBrokeredUser(KeycloakSession, RealmModel, UserModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
updateBrokeredUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
Called when this user has logged in before and has already been imported.
updateClient(ClientRepresentation, ClientModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateClientTemplate(ClientTemplateRepresentation, ClientTemplateModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateComponent(KeycloakSession, ComponentRepresentation, ComponentModel, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
UPDATED_EMAIL - Static variable in interface org.keycloak.events.Details
 
UPDATED_REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
updateOTPRequiredAction(RequiredActionProviderModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
updateRealm(RealmRepresentation, RealmModel, KeycloakSession) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateScopes(Set<Scope>) - Method in interface org.keycloak.authorization.model.Resource
 
updateUserSession(UserSessionModel, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
updateUserSession(UserSessionModel, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
UpperCasePasswordPolicyProvider - Class in org.keycloak.policy
 
UpperCasePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
UpperCasePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
UpperCasePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
USE_TRUSTSTORE_ALWAYS - Static variable in class org.keycloak.models.LDAPConstants
 
USE_TRUSTSTORE_LDAPS_ONLY - Static variable in class org.keycloak.models.LDAPConstants
 
USE_TRUSTSTORE_NEVER - Static variable in class org.keycloak.models.LDAPConstants
 
USE_TRUSTSTORE_SPI - Static variable in class org.keycloak.models.LDAPConstants
 
user(UserModel) - Method in class org.keycloak.events.EventBuilder
 
user(String) - Method in class org.keycloak.events.EventBuilder
 
user(String) - Method in interface org.keycloak.events.EventQuery
 
USER_ACCOUNT_CONTROL - Static variable in class org.keycloak.models.LDAPConstants
 
USER_ATTRIBUTES_PREFIX - Static variable in interface org.keycloak.models.Constants
 
USER_DISABLED - Static variable in interface org.keycloak.events.Errors
 
USER_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
USER_OBJECT_CLASSES - Static variable in class org.keycloak.models.LDAPConstants
 
USER_PASSWORD_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 
USER_SESSION_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
USER_TEMPORARILY_DISABLED - Static variable in interface org.keycloak.events.Errors
 
UserCacheProviderFactory - Interface in org.keycloak.models.cache
 
UserFederationEventAwareProviderFactory - Class in org.keycloak.models
Provides "onProviderModelCreated" callback invoked when UserFederationProviderModel for this factory implementation is created in realm
UserFederationEventAwareProviderFactory() - Constructor for class org.keycloak.models.UserFederationEventAwareProviderFactory
 
UserFederationMapper - Interface in org.keycloak.mappers
 
UserFederationMapperFactory - Interface in org.keycloak.mappers
 
UserFederationMapperSpi - Class in org.keycloak.mappers
 
UserFederationMapperSpi() - Constructor for class org.keycloak.mappers.UserFederationMapperSpi
 
UserFederationProviderCreationEventImpl - Class in org.keycloak.models
 
UserFederationProviderCreationEventImpl(RealmModel, UserFederationProviderModel) - Constructor for class org.keycloak.models.UserFederationProviderCreationEventImpl
 
UserFederationSpi - Class in org.keycloak.models
 
UserFederationSpi() - Constructor for class org.keycloak.models.UserFederationSpi
 
UserFederationValidatingProviderFactory - Interface in org.keycloak.models
TODO: Merge with UserFederationProviderFactory and add "default" method validateConfig with empty body once we move to source level 1.8
UserModelDelegate - Class in org.keycloak.models.utils
 
UserModelDelegate(UserModel) - Constructor for class org.keycloak.models.utils.UserModelDelegate
 
USERNAME - Static variable in interface org.keycloak.events.Details
 
USERNAME - Static variable in class org.keycloak.models.ClaimMask
 
USERNAME_EDIT_DISABLED - Static variable in interface org.keycloak.forms.login.LoginFormsProvider
 
USERNAME_IN_USE - Static variable in interface org.keycloak.events.Errors
 
USERNAME_LDAP_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 
USERNAME_MISSING - Static variable in interface org.keycloak.events.Errors
 
UserProviderFactory - Interface in org.keycloak.models
 
USERS_DN - Static variable in class org.keycloak.models.LDAPConstants
 
UserSessionPersisterProvider - Interface in org.keycloak.models.session
 
UserSessionPersisterProviderFactory - Interface in org.keycloak.models.session
 
UserSessionPersisterSpi - Class in org.keycloak.models.session
 
UserSessionPersisterSpi() - Constructor for class org.keycloak.models.session.UserSessionPersisterSpi
 
UserSessionProviderFactory - Interface in org.keycloak.models
 
UserSessionSpi - Class in org.keycloak.models
 
UserSessionSpi() - Constructor for class org.keycloak.models.UserSessionSpi
 
UsersExportStrategy - Enum in org.keycloak.exportimport
 
UserSpi - Class in org.keycloak.models
 
UserSpi() - Constructor for class org.keycloak.models.UserSpi
 
UserSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
UserSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.UserSynchronizer
 
UUID_LDAP_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 

V

validate(ValidationContext) - Method in interface org.keycloak.authentication.FormAction
This is the first phase of form processing.
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
validate(String, String) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
validate(String, String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in interface org.keycloak.policy.PasswordPolicyManagerProvider
 
validate(String, String) - Method in interface org.keycloak.policy.PasswordPolicyManagerProvider
 
validate(String, String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
VALIDATE_ACCESS_TOKEN - Static variable in interface org.keycloak.events.Details
 
validateConfig(RealmModel, UserFederationProviderModel, UserFederationMapperModel) - Method in interface org.keycloak.mappers.UserFederationMapperFactory
Called when instance of mapperModel is created for this factory through admin endpoint
validateConfig(RealmModel, UserFederationProviderModel) - Method in interface org.keycloak.models.UserFederationValidatingProviderFactory
Called when instance of mapperModel is created for this factory through admin endpoint
validateConfig(KeycloakSession, RealmModel, ProtocolMapperContainerModel, ProtocolMapperModel) - Method in interface org.keycloak.protocol.ProtocolMapper
Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint
validateTOTP(String, byte[]) - Method in class org.keycloak.models.utils.TimeBasedOTP
Validates a token using a secret key.
ValidationContext - Interface in org.keycloak.authentication
Interface that encapsulates the current validation that is being performed.
validationError(MultivaluedMap<String, String>, List<FormMessage>) - Method in interface org.keycloak.authentication.ValidationContext
Mark this validation as having a validation error
validOTP(RealmModel, String, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
valueOf(String) - Static method in enum org.keycloak.authentication.AuthenticationFlowError
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authentication.FlowStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authentication.RequiredActionContext.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.Decision.Effect
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.admin.OperationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.admin.ResourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.exportimport.Strategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.exportimport.UsersExportStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.forms.account.AccountPages
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.forms.login.LoginFormsPages
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.utils.reflection.TypedPropertyCriteria.MatchOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.protocol.LoginProtocol.Error
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.services.managers.ClientSessionCode.ActionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.theme.Theme.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.truststore.HostnameVerificationPolicy
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.keycloak.authentication.AuthenticationFlowError
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.authentication.FlowStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.authentication.RequiredActionContext.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.authorization.Decision.Effect
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.admin.OperationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.admin.ResourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.exportimport.Strategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.exportimport.UsersExportStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.forms.account.AccountPages
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.forms.login.LoginFormsPages
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.utils.reflection.TypedPropertyCriteria.MatchOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.protocol.LoginProtocol.Error
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.services.managers.ClientSessionCode.ActionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.theme.Theme.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.truststore.HostnameVerificationPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
VENDOR - Static variable in class org.keycloak.models.LDAPConstants
 
VENDOR_ACTIVE_DIRECTORY - Static variable in class org.keycloak.models.LDAPConstants
 
VENDOR_NOVELL_EDIRECTORY - Static variable in class org.keycloak.models.LDAPConstants
 
VENDOR_OTHER - Static variable in class org.keycloak.models.LDAPConstants
 
VENDOR_RHDS - Static variable in class org.keycloak.models.LDAPConstants
 
VENDOR_TIVOLI - Static variable in class org.keycloak.models.LDAPConstants
 
verify(String, CredentialModel) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
verify(String, String) - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
VERIFY_EMAIL_KEY - Static variable in interface org.keycloak.models.Constants
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_2_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_3_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_4_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_5_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_6_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_7_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_8_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_9_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo1_9_2
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo2_0_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo2_1_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo2_2_0
 
VERSION - Static variable in class org.keycloak.migration.migrators.MigrateTo2_3_0
 
VIEW_AUTHORIZATION - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_CLIENTS - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_EVENTS - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_IDENTITY_PROVIDERS - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_PROFILE - Static variable in interface org.keycloak.models.AccountRoles
 
VIEW_REALM - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_USERS - Static variable in class org.keycloak.models.AdminRoles
 

W

waitForLock() - Method in interface org.keycloak.models.dblock.DBLockProvider
Try to retrieve DB lock or wait if retrieve was unsuccessful.
WEBSITE - Static variable in class org.keycloak.models.ClaimMask
 
A B C D E F G H I J K L M N O P R S T U V W 
Skip navigation links
Keycloak Server Private SPI 2.4.0.CR1

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