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

A

AbstractAuthenticationFlowContext - Interface in org.keycloak.authentication
 
AbstractIdentifiableEntity - Class in org.keycloak.models.entities
Base for the identifiable entity
AbstractIdentifiableEntity() - Constructor for class org.keycloak.models.entities.AbstractIdentifiableEntity
 
AbstractIdentityProvider<C extends IdentityProviderModel> - Class in org.keycloak.broker.provider
 
AbstractIdentityProvider(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.
ACTION_KEY - Static variable in interface org.keycloak.models.ClientSessionModel
 
add(UserFederationSyncResult) - Method in class org.keycloak.models.UserFederationSyncResult
 
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
 
addAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
addAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
addAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
addChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
Automatically calls setParent() on the subGroup
addClient(String) - Method in interface org.keycloak.models.RealmModel
 
addClient(String, String) - Method in interface org.keycloak.models.RealmModel
 
addClient(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addClient(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientRole(RealmModel, ClientModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addClientTemplate(String) - Method in interface org.keycloak.models.RealmModel
 
addClientTemplate(String, String) - Method in interface org.keycloak.models.RealmModel
 
addCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
addConsent(UserConsentModel) - Method in interface org.keycloak.models.UserModel
 
addConsent(UserConsentModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
addCriteria(PropertyCriteria) - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Add a criteria to query
addDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
addDefaultRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
addDefaults(ClientModel) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
addError(FormMessage) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
addFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in class org.keycloak.models.UserFederationManager
 
addFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
 
addFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
addGrantedProtocolMapper(ProtocolMapperModel) - Method in class org.keycloak.models.UserConsentModel
 
addGrantedRole(RoleModel) - Method in class org.keycloak.models.UserConsentModel
 
addIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
 
addIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
addProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
addReadTokenRoleOnCreate - Variable in class org.keycloak.models.entities.IdentityProviderEntity
 
addReadTokenRoleOnCreate - Variable in class org.keycloak.models.IdentityProviderModel
 
addRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
addRealmRole(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
addRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
 
addRequiredAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.ClientSessionModel
 
addRequiredAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
addRequiredAction(String) - Method in interface org.keycloak.models.UserModel
 
addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
 
addRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
 
addRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
addRequiredCredential(String) - Method in interface org.keycloak.models.RealmModel
 
addResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
ADDRESS - Static variable in class org.keycloak.models.ClaimMask
 
addRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
addRole(String, String) - Method in interface org.keycloak.models.RoleContainerModel
 
addScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
addScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
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
addTopLevelGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
Move Group to top realm level.
addTopLevelGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
addUser(RealmModel, String, String, boolean, boolean) - Method in class org.keycloak.models.UserFederationManager
 
addUser(RealmModel, String) - Method in class org.keycloak.models.UserFederationManager
 
addUser(RealmModel, String, String, boolean, boolean) - Method in interface org.keycloak.models.UserProvider
 
addUser(RealmModel, String) - Method in interface org.keycloak.models.UserProvider
 
addUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
addUserFederationProvider(String, Map<String, String>, int, String, int, int, int) - Method in interface org.keycloak.models.RealmModel
 
addUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
addWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
 
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
 
adminEventsDetailsEnabled - Variable in class org.keycloak.models.entities.RealmEntity
 
adminEventsEnabled - Variable in class org.keycloak.models.entities.RealmEntity
 
AdminRoles - Class in org.keycloak.models
 
AdminRoles() - Constructor for class org.keycloak.models.AdminRoles
 
algorithm - Variable in class org.keycloak.models.entities.CredentialEntity
 
algorithm - Variable in class org.keycloak.models.OTPPolicy
 
algorithm - Variable in class org.keycloak.models.UserCredentialModel
 
algorithm - Variable in class org.keycloak.models.utils.HmacOTP
 
alias - Variable in class org.keycloak.models.entities.AuthenticationFlowEntity
 
alias - Variable in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
alias - Variable in class org.keycloak.models.entities.RequiredActionProviderEntity
 
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 - Variable in class org.keycloak.models.entities.ClientEntity
 
attributes - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
AuthenticationExecutionEntity - Class in org.keycloak.models.entities
 
AuthenticationExecutionEntity() - Constructor for class org.keycloak.models.entities.AuthenticationExecutionEntity
 
AuthenticationExecutionModel - Class in org.keycloak.models
 
AuthenticationExecutionModel() - Constructor for class org.keycloak.models.AuthenticationExecutionModel
 
AuthenticationExecutionModel.ExecutionComparator - Class in org.keycloak.models
 
AuthenticationExecutionModel.Requirement - Enum in org.keycloak.models
 
AuthenticationFlow - Interface in org.keycloak.authentication
 
AuthenticationFlowContext - Interface in org.keycloak.authentication
This interface encapsulates information about an execution in an AuthenticationFlow.
AuthenticationFlowEntity - Class in org.keycloak.models.entities
 
AuthenticationFlowEntity() - Constructor for class org.keycloak.models.entities.AuthenticationFlowEntity
 
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
 
AuthenticationFlowModel - Class in org.keycloak.models
 
AuthenticationFlowModel() - Constructor for class org.keycloak.models.AuthenticationFlowModel
 
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.
authenticator - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
authenticatorConfig - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
AuthenticatorConfigEntity - Class in org.keycloak.models.entities
 
AuthenticatorConfigEntity() - Constructor for class org.keycloak.models.entities.AuthenticatorConfigEntity
 
AuthenticatorConfigModel - Class in org.keycloak.models
 
AuthenticatorConfigModel() - Constructor for class org.keycloak.models.AuthenticatorConfigModel
 
AuthenticatorFactory - Interface in org.keycloak.authentication
Factory for creating Authenticator instances.
authenticatorFlow - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
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, StoreFactory, Executor) - Constructor for class org.keycloak.authorization.AuthorizationProvider
 
AuthorizationProvider(KeycloakSession, 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
 
Base32 - Class in org.keycloak.models.utils
Base32 - encodes and decodes RFC3548 Base32 (see http://www.faqs.org/rfcs/rfc3548.html )
Base32() - Constructor for class org.keycloak.models.utils.Base32
 
BASE_DN - Static variable in class org.keycloak.models.LDAPConstants
 
baseUrl - Variable in class org.keycloak.models.entities.ClientEntity
 
BASIC_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
BATCH_SIZE_FOR_SYNC - Static variable in class org.keycloak.models.LDAPConstants
 
bearerOnly - Variable in class org.keycloak.models.entities.ClientEntity
 
bearerOnly - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
begin() - Method in interface org.keycloak.models.KeycloakTransaction
 
BIND_CREDENTIAL - Static variable in class org.keycloak.models.LDAPConstants
 
BIND_DN - Static variable in class org.keycloak.models.LDAPConstants
 
BOOLEAN_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
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.
BUILT_IN - Static variable in class org.keycloak.models.RequiredCredentialModel
 
builtIn - Variable in class org.keycloak.models.entities.AuthenticationFlowEntity
 

C

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
 
CacheUserProvider - Interface in org.keycloak.models.cache
 
CacheUserProviderFactory - Interface in org.keycloak.models.cache
 
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
checkForcedUnlock() - Method in class org.keycloak.models.dblock.DBLockManager
 
ClaimMask - Class in org.keycloak.models
 
ClaimMask() - Constructor for class org.keycloak.models.ClaimMask
 
ClaimTypeModel - Class in org.keycloak.models
 
ClaimTypeModel(ClaimTypeModel) - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel(String, String, boolean, ClaimTypeModel.ValueType) - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel() - Constructor for class org.keycloak.models.ClaimTypeModel
 
ClaimTypeModel.ValueType - Enum in org.keycloak.models
 
clear() - Method in interface org.keycloak.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
 
clear() - Method in interface org.keycloak.models.cache.CacheUserProvider
 
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 interface org.keycloak.models.ClientSessionModel
 
clearExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
clearFailures() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
clearFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
clearUser() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Clear the user from the flow.
clearUserSessionNotes() - Method in interface org.keycloak.models.ClientSessionModel
 
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_CERT - Static variable in class org.keycloak.models.RequiredCredentialModel
 
CLIENT_CERT - Static variable in class org.keycloak.models.UserCredentialModel
 
CLIENT_DISABLED - Static variable in interface org.keycloak.events.Errors
 
CLIENT_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
CLIENT_LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
CLIENT_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
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
 
clientAuthenticatorType - Variable in class org.keycloak.models.entities.ClientEntity
 
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
 
ClientEntity - Class in org.keycloak.models.entities
 
ClientEntity() - Constructor for class org.keycloak.models.entities.ClientEntity
 
clientId - Variable in class org.keycloak.models.entities.ClientEntity
 
ClientIdentityProviderMappingEntity - Class in org.keycloak.models.entities
 
ClientIdentityProviderMappingEntity() - Constructor for class org.keycloak.models.entities.ClientIdentityProviderMappingEntity
 
ClientInitialAccessModel - Interface in org.keycloak.models
 
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
 
ClientModel - Interface in org.keycloak.models
 
ClientSessionCode - Class in org.keycloak.services.managers
 
ClientSessionCode(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
 
ClientSessionModel - Interface in org.keycloak.models
 
ClientSessionModel.Action - Enum in org.keycloak.models
 
ClientSessionModel.ExecutionStatus - Enum in org.keycloak.models
 
clientTemplate - Variable in class org.keycloak.models.ClientConfigResolver
 
clientTemplate - Variable in class org.keycloak.models.entities.ClientEntity
 
ClientTemplateEntity - Class in org.keycloak.models.entities
 
ClientTemplateEntity() - Constructor for class org.keycloak.models.entities.ClientTemplateEntity
 
ClientTemplateModel - Interface in org.keycloak.models
 
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 class org.keycloak.hash.Pbkdf2PasswordHashProvider
 
close() - Method in interface org.keycloak.models.KeycloakSession
 
close() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
close() - Method in interface org.keycloak.models.RealmProvider
 
close() - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
close() - Method in class org.keycloak.models.UserFederationManager
 
close() - Method in interface org.keycloak.models.UserFederationProvider
This method is called at the end of requests.
close() - Method in interface org.keycloak.models.UserProvider
 
close() - Method in interface org.keycloak.models.UserSessionProvider
 
close() - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
close() - Method in interface org.keycloak.provider.Provider
 
close() - Method in interface org.keycloak.provider.ProviderFactory
This is called when the server shuts down.
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
 
commit() - Method in interface org.keycloak.models.KeycloakTransaction
 
compare(AuthenticationExecutionModel, AuthenticationExecutionModel) - Method in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
config - Variable in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
config - Variable in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
config - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
config - Variable in class org.keycloak.models.entities.UserFederationMapperEntity
 
config - Variable in class org.keycloak.models.entities.UserFederationProviderEntity
 
config - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
config - Variable in class org.keycloak.models.ProtocolMapperModel
 
config - Variable in class org.keycloak.models.UserFederationMapperModel
 
ConfigConstants - Interface in org.keycloak.broker.provider
 
ConfigurableAuthenticatorFactory - Interface in org.keycloak.authentication
 
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?
configuredForCredentialType(String, RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
Is the user configured to use this credential type
ConfiguredProvider - Interface in org.keycloak.provider
 
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
 
consentRequired - Variable in class org.keycloak.models.entities.ClientEntity
 
consentRequired - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
consentRequired - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
consentRequired - Variable in class org.keycloak.models.ProtocolMapperModel
 
consentText - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
consentText - Variable in class org.keycloak.models.ProtocolMapperModel
 
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
 
counter - Variable in class org.keycloak.models.entities.CredentialEntity
 
create() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
 
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(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.hash.Pbkdf2PasswordHashProvider
 
create() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
create(KeycloakSession) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
create(KeycloakSession) - Method in interface org.keycloak.models.UserFederationProviderFactory
This method is never called and is only an artifact of ProviderFactory.
create(KeycloakSession) - Method in interface org.keycloak.provider.ProviderFactory
 
create(ClassLoader, String) - Method in interface org.keycloak.provider.ProviderLoaderFactory
 
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!
createClientInitialAccessModel(RealmModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
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
 
createClientSession(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
createClientTemplate(KeycloakSession, RealmModel, ClientTemplateRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createCode() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createCredentials(UserRepresentation, UserModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createdDate - Variable in class org.keycloak.models.entities.CredentialEntity
 
createErrorPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createForm(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createGroup(String) - Method in interface org.keycloak.models.RealmModel
 
createGroup(String, String) - Method in interface org.keycloak.models.RealmModel
 
createGroup(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
createGroup(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
 
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
 
createOfflineClientSession(ClientSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
createOfflineUserSession(UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
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
 
createQuery() - Method in interface org.keycloak.events.EventStoreProvider
 
createQuery(Class<?>) - Static method in class org.keycloak.models.utils.reflection.PropertyQueries
Create a new PropertyQuery
createRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
createRealm(String, String) - Method in interface org.keycloak.models.RealmProvider
 
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
 
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
 
createUserSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionProvider
 
CredentialEntity - Class in org.keycloak.models.entities
 
CredentialEntity() - Constructor for class org.keycloak.models.entities.CredentialEntity
 
CredentialValidation - Class in org.keycloak.models.utils
 
CredentialValidation() - Constructor for class org.keycloak.models.utils.CredentialValidation
 
CredentialValidationOutput - Class in org.keycloak.models
Output of credential validation
CredentialValidationOutput(UserModel, CredentialValidationOutput.Status, Map<String, String>) - Constructor for class org.keycloak.models.CredentialValidationOutput
 
CredentialValidationOutput.Status - Enum in org.keycloak.models
 
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
 
decode(String) - Static method in class org.keycloak.models.utils.Base32
Decodes the given Base32 String to a raw byte array.
decreaseRemainingCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
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_ALGORITHM - Static variable in class org.keycloak.models.utils.HmacOTP
 
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_HASH_ALGORITHM - Static variable in interface org.keycloak.models.Constants
 
DEFAULT_INTERVAL_SECONDS - Static variable in class org.keycloak.models.utils.TimeBasedOTP
 
DEFAULT_NUMBER_DIGITS - Static variable in class org.keycloak.models.utils.HmacOTP
 
DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT - Static variable in interface org.keycloak.models.Constants
 
DEFAULT_POLICY - Static variable in class org.keycloak.models.OTPPolicy
 
defaultAction - Variable in class org.keycloak.models.entities.RequiredActionProviderEntity
 
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
 
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
 
defaultRoles - Variable in class org.keycloak.models.entities.ClientEntity
 
defaultValue - Variable in class org.keycloak.provider.ProviderConfigProperty
 
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.
deleteInvalidUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
deleteRoleMapping(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
 
deleteRoleMapping(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
deleteScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
deny() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
deny() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Denies the requested permission.
description - Variable in class org.keycloak.models.entities.AuthenticationFlowEntity
 
description - Variable in class org.keycloak.models.entities.ClientEntity
 
description - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
device - Variable in class org.keycloak.models.entities.CredentialEntity
 
device - Variable in class org.keycloak.models.UserCredentialModel
 
digits - Variable in class org.keycloak.models.entities.CredentialEntity
 
digits - Variable in class org.keycloak.models.OTPPolicy
 
DIRECT_GRANT_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
directAccessGrantsEnabled - Variable in class org.keycloak.models.entities.ClientEntity
 
directAccessGrantsEnabled - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
displayName - Variable in class org.keycloak.models.entities.UserFederationProviderEntity
 
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 - Static variable in interface org.keycloak.models.UserFederationProvider
 
EMAIL - Static variable in interface org.keycloak.models.UserModel
 
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 method in class org.keycloak.models.UserFederationSyncResult
 
EMPTY - Static variable in interface org.keycloak.scripting.ScriptBindingsConfigurer
A default ScriptBindingsConfigurer leaves the Bindings empty.
EMPTY_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
EMPTY_MEMBER_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
enabled - Variable in class org.keycloak.models.entities.ClientEntity
 
enabled - Variable in class org.keycloak.models.entities.RequiredActionProviderEntity
 
encode(KeycloakSession, RealmModel, String) - Static method in class org.keycloak.hash.PasswordHashManager
 
encode(KeycloakSession, PasswordPolicy, String) - Static method in class org.keycloak.hash.PasswordHashManager
 
encode(String, int) - Method in interface org.keycloak.hash.PasswordHashProvider
 
encode(String, int) - Method in class org.keycloak.hash.Pbkdf2PasswordHashProvider
 
encode(byte[]) - Static method in class org.keycloak.models.utils.Base32
Encodes byte array to Base32 String.
encode(String) - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
enlist(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
enlistAfterCompletion(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
enlistForClose(Provider) - Method in interface org.keycloak.models.KeycloakSession
 
enlistPrepare(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
 
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_UUID - Static variable in class org.keycloak.models.LDAPConstants
 
EQUAL - Static variable in class org.keycloak.models.LDAPConstants
 
equals(Object) - Method in class org.keycloak.models.ClaimTypeModel
 
equals(Object) - Method in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
equals(Object) - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
equals(Object) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
equals(Object) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
equals(Object) - Method in class org.keycloak.models.ProtocolMapperModel
 
equals(Object) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
equals(Object) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
equals(Object) - Method in class org.keycloak.models.UserFederationMapperModel
 
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
 
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).
ExecutionComparator() - Constructor for class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
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
 

F

failed() - Static method in class org.keycloak.models.CredentialValidationOutput
 
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
 
FederatedIdentityEntity - Class in org.keycloak.models.entities
 
FederatedIdentityEntity() - Constructor for class org.keycloak.models.entities.FederatedIdentityEntity
 
FederatedIdentityModel - Class in org.keycloak.models
 
FederatedIdentityModel(String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
 
FederatedIdentityModel(String, String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
 
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
 
federationMapperType - Variable in class org.keycloak.models.entities.UserFederationMapperEntity
 
federationMapperType - Variable in class org.keycloak.models.UserFederationMapperModel
 
federationProviderId - Variable in class org.keycloak.models.entities.UserFederationMapperEntity
 
federationProviderId - Variable in class org.keycloak.models.UserFederationMapperModel
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
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(String) - 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.
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
 
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
 
FIRST_NAME - Static variable in interface org.keycloak.models.UserFederationProvider
 
FIRST_NAME - Static variable in interface org.keycloak.models.UserModel
 
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
 
flowId - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
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
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
formLabel - Variable in class org.keycloak.models.RequiredCredentialModel
 
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 - Variable in class org.keycloak.models.entities.ClientEntity
 
frontchannelLogout - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
frontchannelLogout(UserSessionModel, ClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
fullScopeAllowed - Variable in class org.keycloak.models.entities.ClientEntity
 
fullScopeAllowed - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 

G

GENDER - Static variable in class org.keycloak.models.ClaimMask
 
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
 
generateHOTP(String, int) - Method in class org.keycloak.models.utils.HmacOTP
 
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
 
generateOTP(String, String, int, String) - Method in class org.keycloak.models.utils.HmacOTP
This method generates an OTP value for the given set of parameters.
generateRealmCertificate(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateRealmKeys(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateSecret() - Static method in class org.keycloak.models.UserCredentialModel
 
generateSecret(int) - Static method in class org.keycloak.models.utils.HmacOTP
 
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
getAccessCodeLifespan() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccessCodeLifespan() - Method in interface org.keycloak.models.RealmModel
 
getAccessCodeLifespanLogin() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccessCodeLifespanLogin() - Method in interface org.keycloak.models.RealmModel
 
getAccessCodeLifespanUserAction() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccessCodeLifespanUserAction() - Method in interface org.keycloak.models.RealmModel
 
getAccessTokenLifespan() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccessTokenLifespan() - Method in interface org.keycloak.models.RealmModel
 
getAccessTokenLifespanForImplicitFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccessTokenLifespanForImplicitFlow() - Method in interface org.keycloak.models.RealmModel
 
getAccountTheme() - Method in class org.keycloak.models.entities.RealmEntity
 
getAccountTheme() - Method in interface org.keycloak.models.RealmModel
 
getAction() - Method in interface org.keycloak.models.ClientSessionModel
 
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.
getActiveUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getAdapterConfiguration(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client.
getAdded() - Method in class org.keycloak.models.UserFederationSyncResult
 
getAdminResource(ResourceServer) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getAdminTheme() - Method in class org.keycloak.models.entities.RealmEntity
 
getAdminTheme() - Method in interface org.keycloak.models.RealmModel
 
getAlgorithm() - Method in class org.keycloak.models.entities.CredentialEntity
 
getAlgorithm() - Method in class org.keycloak.models.OTPPolicy
 
getAlgorithm() - Method in class org.keycloak.models.UserCredentialModel
 
getAlgorithm() - Method in class org.keycloak.models.UserCredentialValueModel
 
getAlias() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getAlias() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getAlias() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
getAlias() - Method in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
getAlias() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getAlias() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
getAlias() - Method in class org.keycloak.models.IdentityProviderModel
 
getAlias() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getAllProviders(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
 
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 interface org.keycloak.models.ClientModel
 
getAttribute(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
getAttribute(String) - Method in interface org.keycloak.models.GroupModel
 
getAttribute(String) - Method in interface org.keycloak.models.UserModel
 
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 interface org.keycloak.models.ClientModel
 
getAttributes() - Method in interface org.keycloak.models.ClientTemplateModel
 
getAttributes() - Method in class org.keycloak.models.entities.ClientEntity
 
getAttributes() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getAttributes() - Method in class org.keycloak.models.entities.GroupEntity
 
getAttributes() - Method in class org.keycloak.models.entities.UserEntity
 
getAttributes() - Method in interface org.keycloak.models.GroupModel
 
getAttributes() - Method in interface org.keycloak.models.UserModel
 
getAttributes() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getAuthDetails() - Method in class org.keycloak.events.admin.AdminEvent
Returns authentication details
getAuthenticatedUser() - Method in interface org.keycloak.models.ClientSessionModel
 
getAuthenticatedUser() - Method in class org.keycloak.models.CredentialValidationOutput
 
getAuthenticatedUser() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getAuthenticationExecutionById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationExecutions(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationFlowById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticationFlows() - Method in class org.keycloak.models.entities.RealmEntity
 
getAuthenticationFlows() - Method in interface org.keycloak.models.RealmModel
 
getAuthenticator() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getAuthenticator() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
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
getAuthenticatorConfig() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getAuthenticatorConfig() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
getAuthenticatorConfigByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticatorConfigById(String) - Method in interface org.keycloak.models.RealmModel
 
getAuthenticatorConfigs() - Method in class org.keycloak.models.entities.RealmEntity
 
getAuthenticatorConfigs() - Method in interface org.keycloak.models.RealmModel
 
getAuthMethod() - Method in interface org.keycloak.models.ClientSessionModel
Authentication request type, i.e.
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
 
getAuthMethod() - Method in interface org.keycloak.models.UserSessionModel
 
getAuthServerUrl() - Method in interface org.keycloak.models.KeycloakContext
 
getAuthStatus() - Method in class org.keycloak.models.CredentialValidationOutput
 
getBaseType() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property type
getBaseUrl() - Method in interface org.keycloak.models.ClientModel
 
getBaseUrl() - Method in class org.keycloak.models.entities.ClientEntity
 
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
 
getBrokerSessionId() - Method in interface org.keycloak.models.UserSessionModel
If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession
getBrokerUserId() - Method in 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
 
getBrokerUserId() - Method in interface org.keycloak.models.UserSessionModel
 
getBrowserFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getBrowserFlow() - Method in interface org.keycloak.models.RealmModel
 
getBrowserSecurityHeaders() - Method in class org.keycloak.models.entities.RealmEntity
 
getBrowserSecurityHeaders() - Method in interface org.keycloak.models.RealmModel
 
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.
getCategoryRequirementFromCurrentFlow(String) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getCertificate() - Method in interface org.keycloak.models.RealmModel
 
getCertificate(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getCertificatePem() - Method in class org.keycloak.models.entities.RealmEntity
 
getCertificatePem() - Method in interface org.keycloak.models.RealmModel
 
getChallenge() - Method in interface org.keycloak.authentication.RequiredActionContext
If challenge has been sent this returns the JAX-RS Response
getChangedSyncPeriod() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getChangedSyncPeriod() - Method in class org.keycloak.models.UserFederationProviderModel
 
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 interface org.keycloak.models.ClientSessionModel
 
getClient() - Method in interface org.keycloak.models.KeycloakContext
 
getClient() - Method in interface org.keycloak.models.RealmModel.ClientRemovedEvent
 
getClient() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getClient() - Method in class org.keycloak.models.UserConsentModel
 
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.
getClientAuthenticationFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getClientAuthenticationFlow() - Method in interface org.keycloak.models.RealmModel
 
getClientAuthenticatorType() - Method in interface org.keycloak.models.ClientModel
 
getClientAuthenticatorType() - Method in class org.keycloak.models.entities.ClientEntity
 
getClientByClientId(String) - Method in interface org.keycloak.models.RealmModel
 
getClientByClientId(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientById(String) - Method in interface org.keycloak.models.RealmModel
 
getClientById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientId() - Method in interface org.keycloak.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 interface org.keycloak.models.ClientModel
 
getClientId() - Method in class org.keycloak.models.entities.ClientEntity
 
getClientId() - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
getClientId() - Method in class org.keycloak.models.entities.RoleEntity
 
getClientId() - Method in class org.keycloak.models.entities.UserConsentEntity
 
getClientId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
 
getClientRoleMappings(ClientModel) - Method in interface org.keycloak.models.RoleMapperModel
 
getClientRoleMappings(ClientModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getClientRoles(RealmModel, ClientModel) - Method in interface org.keycloak.models.RealmProvider
 
getClients() - Method in interface org.keycloak.models.RealmModel
 
getClients(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
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(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getClientSession(String) - Method in interface org.keycloak.models.UserSessionProvider
 
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.entities.PersistentClientSessionEntity
 
getClientSessionId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getClientSessions() - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
getClientSessions() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getClientSessions() - Method in interface org.keycloak.models.UserSessionModel
 
getClientTemplate() - Method in interface org.keycloak.models.ClientModel
 
getClientTemplate() - Method in class org.keycloak.models.entities.ClientEntity
 
getClientTemplateById(String) - Method in interface org.keycloak.models.RealmModel
 
getClientTemplateById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getClientTemplateByName(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getClientTemplates() - Method in interface org.keycloak.models.RealmModel
 
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 interface org.keycloak.models.ScriptModel
Returns the actual source code of the script.
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
 
getCodeSecret() - Method in class org.keycloak.models.entities.RealmEntity
 
getCodeSecret() - Method in interface org.keycloak.models.RealmModel
 
getCodeSecretKey() - Method in interface org.keycloak.models.RealmModel
 
getCompatibleProviders() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getCompositeRoleIds() - Method in class org.keycloak.models.entities.RoleEntity
 
getComposites() - Method in interface org.keycloak.models.RoleModel
 
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
 
getConfig() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getConfig() - Method in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
getConfig() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getConfig() - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
getConfig() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
getConfig() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
getConfig() - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
getConfig() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getConfig() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getConfig() - Method in class org.keycloak.models.IdentityProviderModel
 
getConfig() - Method in class org.keycloak.models.ProtocolMapperModel
 
getConfig() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getConfig() - Method in class org.keycloak.models.UserFederationMapperModel
 
getConfig() - Method in class org.keycloak.models.UserFederationProviderModel
 
getConfigProperties() - Method in interface org.keycloak.provider.ConfiguredProvider
 
getConfigPropertiesPerClient() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
List of config properties for this client implementation.
getConfigurationOptions() - Method in interface org.keycloak.models.UserFederationProviderFactory
Config options to display in generic admin console page for federation
getConnection() - Method in interface org.keycloak.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
 
getConnection() - Method in interface org.keycloak.models.KeycloakContext
 
getConsentByClient(String) - Method in interface org.keycloak.models.UserModel
 
getConsentByClient(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getConsents() - Method in interface org.keycloak.models.UserModel
 
getConsents() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getConsentText() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
getConsentText() - Method in class org.keycloak.models.ProtocolMapperModel
 
getContainer() - Method in interface org.keycloak.models.RoleModel
 
getContainerId() - Method in interface org.keycloak.models.RoleModel
 
getContext() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
Returns the PermissionEvaluator.
getContext() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns the EvaluationContext.
getContext() - Method in interface org.keycloak.models.KeycloakSession
 
getContextData() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getContextObject(Class<T>) - Method in interface org.keycloak.models.KeycloakContext
 
getContextPath() - Method in interface org.keycloak.models.KeycloakContext
 
getCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getCounter() - Method in class org.keycloak.models.entities.CredentialEntity
 
getCounter() - Method in class org.keycloak.models.UserCredentialValueModel
 
getCreatedClient() - Method in interface org.keycloak.models.RealmModel.ClientCreationEvent
 
getCreatedDate() - Method in class org.keycloak.models.entities.CredentialEntity
 
getCreatedDate() - Method in class org.keycloak.models.UserCredentialValueModel
 
getCreatedFederationProvider() - Method in interface org.keycloak.models.RealmModel.UserFederationProviderCreationEvent
 
getCreatedFederationProvider() - Method in class org.keycloak.models.UserFederationProviderCreationEventImpl
 
getCreatedRealm() - Method in interface org.keycloak.models.RealmModel.RealmCreationEvent
 
getCreatedTimestamp() - Method in class org.keycloak.models.entities.UserEntity
 
getCreatedTimestamp() - Method in interface org.keycloak.models.UserModel
Get timestamp of user creation.
getCreatedTimestamp() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getCredentials() - Method in class org.keycloak.models.entities.UserEntity
 
getCredentialsDirectly() - Method in interface org.keycloak.models.UserModel
 
getCredentialsDirectly() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getData() - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
getData() - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
getData() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getData() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getDaysToExpirePassword() - Method in class org.keycloak.models.PasswordPolicy
 
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 Policy.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
getDefaultGroups() - Method in class org.keycloak.models.entities.RealmEntity
 
getDefaultGroups() - Method in interface org.keycloak.models.RealmModel
 
getDefaultLocale() - Method in class org.keycloak.models.entities.RealmEntity
 
getDefaultLocale() - Method in interface org.keycloak.models.RealmModel
 
getDefaultRoles() - Method in class org.keycloak.models.entities.ClientEntity
 
getDefaultRoles() - Method in class org.keycloak.models.entities.RealmEntity
 
getDefaultRoles() - Method in interface org.keycloak.models.RoleContainerModel
 
getDefaultValue() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getDelegate() - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
getDelegate() - Method in interface org.keycloak.models.cache.CacheUserProvider
 
getDelegate() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getDescription() - Method in interface org.keycloak.authorization.model.Policy
Returns the description of this policy.
getDescription() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getDescription() - Method in interface org.keycloak.models.ClientModel
 
getDescription() - Method in interface org.keycloak.models.ClientTemplateModel
 
getDescription() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
getDescription() - Method in class org.keycloak.models.entities.ClientEntity
 
getDescription() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getDescription() - Method in class org.keycloak.models.entities.RoleEntity
 
getDescription() - Method in interface org.keycloak.models.RoleModel
 
getDescription() - Method in interface org.keycloak.models.ScriptModel
Returns the description of the script.
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
 
getDevice() - Method in class org.keycloak.models.entities.CredentialEntity
 
getDevice() - Method in class org.keycloak.models.UserCredentialModel
 
getDevice() - Method in class org.keycloak.models.UserCredentialValueModel
 
getDigits() - Method in class org.keycloak.models.entities.CredentialEntity
 
getDigits() - Method in class org.keycloak.models.OTPPolicy
 
getDigits() - Method in class org.keycloak.models.UserCredentialValueModel
 
getDirectGrantFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getDirectGrantFlow() - Method in interface org.keycloak.models.RealmModel
 
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.models.entities.RealmEntity
 
getDisplayName() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getDisplayName() - Method in interface org.keycloak.models.RealmModel
 
getDisplayName() - Method in class org.keycloak.models.UserFederationProviderModel
 
getDisplayNameHtml() - Method in class org.keycloak.models.entities.RealmEntity
 
getDisplayNameHtml() - Method in interface org.keycloak.models.RealmModel
 
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.entities.UserEntity
 
getEmail() - Method in interface org.keycloak.models.UserModel
 
getEmail() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getEmailTheme() - Method in class org.keycloak.models.entities.RealmEntity
 
getEmailTheme() - Method in interface org.keycloak.models.RealmModel
 
getEnabledEventTypes() - Method in class org.keycloak.models.entities.RealmEntity
 
getEnabledEventTypes() - Method in interface org.keycloak.models.RealmModel
 
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
 
getEventsExpiration() - Method in class org.keycloak.models.entities.RealmEntity
 
getEventsExpiration() - Method in interface org.keycloak.models.RealmModel
 
getEventsListeners() - Method in class org.keycloak.models.entities.RealmEntity
 
getEventsListeners() - Method in interface org.keycloak.models.RealmModel
 
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
getExecutions() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
getExecutionStatus() - Method in interface org.keycloak.models.ClientSessionModel
 
getExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getExecutionStatus() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getExpiration() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getExpiredPasswords() - Method in class org.keycloak.models.PasswordPolicy
 
getFailed() - Method in class org.keycloak.models.UserFederationSyncResult
 
getFailedLoginNotBefore() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getFailedLoginNotBefore() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getFailureFactor() - Method in class org.keycloak.models.entities.RealmEntity
 
getFailureFactor() - Method in interface org.keycloak.models.RealmModel
 
getFederatedIdentities() - Method in class org.keycloak.models.entities.UserEntity
 
getFederatedIdentities(UserModel, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederatedIdentities(UserModel, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getFederatedIdentity(UserModel, String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederatedIdentity(UserModel, String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getFederationLink() - Method in class org.keycloak.models.entities.UserEntity
 
getFederationLink(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederationLink() - Method in interface org.keycloak.models.UserModel
 
getFederationLink() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getFederationMapperType() - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
getFederationMapperType() - Method in class org.keycloak.models.UserFederationMapperModel
 
getFederationProvider(UserFederationProviderModel) - Method in class org.keycloak.models.UserFederationManager
 
getFederationProviderFactory(KeycloakSession, UserFederationProviderModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getFederationProviderId() - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
getFederationProviderId() - Method in class org.keycloak.models.UserFederationMapperModel
 
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 federation 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 interface org.keycloak.models.GroupModel
 
getFirstAttribute(String) - Method in interface org.keycloak.models.UserModel
 
getFirstAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
getFirstBrokerLoginFlowId() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getFirstBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
 
getFirstName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getFirstName() - Method in class org.keycloak.models.entities.UserEntity
 
getFirstName() - Method in interface org.keycloak.models.UserModel
 
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.
getFlowByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getFlowId() - Method in class org.keycloak.models.AuthenticationExecutionModel
If this execution is a flow, this is the flowId pointing to an AuthenticationFlowModel
getFlowId() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
getFormLabel() - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
getFormLabel() - Method in class org.keycloak.models.RequiredCredentialModel
 
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.
getFullSyncPeriod() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getFullSyncPeriod() - Method in class org.keycloak.models.UserFederationProviderModel
 
getGrantedProtocolMappers() - Method in class org.keycloak.models.entities.UserConsentEntity
 
getGrantedProtocolMappers() - Method in class org.keycloak.models.UserConsentModel
 
getGrantedRoles() - Method in class org.keycloak.models.entities.UserConsentEntity
 
getGrantedRoles() - Method in class org.keycloak.models.UserConsentModel
 
getGroup() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getGroupById(String) - Method in interface org.keycloak.models.RealmModel
 
getGroupById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getGroupIds() - Method in class org.keycloak.models.entities.UserEntity
 
getGroupMembers(UserFederationMapperModel, UserFederationProvider, RealmModel, GroupModel, int, int) - Method in interface org.keycloak.mappers.UserFederationMapper
Return empty list if doesn't support storing of groups
getGroupMembers(RealmModel, GroupModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
getGroupMembers(RealmModel, GroupModel) - Method in class org.keycloak.models.UserFederationManager
 
getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.models.UserFederationProvider
Return group members from federation storage.
getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.models.UserProvider
 
getGroupMembers(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserProvider
 
getGroups() - Method in interface org.keycloak.models.RealmModel
 
getGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getGroups() - Method in interface org.keycloak.models.UserModel
 
getGroups() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getHashAlgorithm() - Method in class org.keycloak.models.PasswordPolicy
 
getHashIterations() - Method in class org.keycloak.models.entities.CredentialEntity
 
getHashIterations() - Method in class org.keycloak.models.PasswordPolicy
 
getHashIterations() - Method in class org.keycloak.models.UserCredentialValueModel
 
getHelpText() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getHelpText() - Method in interface org.keycloak.provider.ConfiguredProvider
 
getHelpText() - Method in class org.keycloak.provider.ProviderConfigProperty
 
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 class org.keycloak.hash.Pbkdf2PasswordHashProvider
 
getId() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getId() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getId() - Method in class org.keycloak.models.AuthenticatorConfigModel
 
getId() - Method in class org.keycloak.models.ClaimTypeModel
 
getId() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getId() - Method in interface org.keycloak.models.ClientModel
 
getId() - Method in interface org.keycloak.models.ClientSessionModel
 
getId() - Method in interface org.keycloak.models.ClientTemplateModel
 
getId() - Method in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
getId() - Method in interface org.keycloak.models.GroupModel
 
getId() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getId() - Method in class org.keycloak.models.ProtocolMapperModel
 
getId() - Method in interface org.keycloak.models.RealmModel
 
getId() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getId() - Method in interface org.keycloak.models.RoleContainerModel
 
getId() - Method in interface org.keycloak.models.RoleModel
 
getId() - Method in interface org.keycloak.models.ScriptModel
Returns the unique id of the script.
getId() - Method in class org.keycloak.models.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.UserFederationMapperModel
 
getId() - Method in interface org.keycloak.models.UserFederationProviderFactory
This is the name of the provider and will be showed in the admin console as an option.
getId() - Method in class org.keycloak.models.UserFederationProviderModel
 
getId() - Method in interface org.keycloak.models.UserModel
 
getId() - Method in interface org.keycloak.models.UserSessionModel
 
getId() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getId() - Method in interface org.keycloak.provider.ProviderFactory
 
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.
getIdentityProvider() - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
getIdentityProvider() - Method in class org.keycloak.models.FederatedIdentityModel
 
getIdentityProviderAlias() - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
getIdentityProviderAlias() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMapper() - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
getIdentityProviderMapper() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getIdentityProviderMapperById(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMappers() - Method in class org.keycloak.models.entities.RealmEntity
 
getIdentityProviderMappers() - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviderMappersByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getIdentityProviders() - Method in class org.keycloak.models.entities.ClientEntity
 
getIdentityProviders() - Method in class org.keycloak.models.entities.RealmEntity
 
getIdentityProviders() - Method in interface org.keycloak.models.RealmModel
 
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
 
getInitialCounter() - Method in class org.keycloak.models.OTPPolicy
 
getInstance(KeycloakSession, UserFederationProviderModel) - Method in interface org.keycloak.models.UserFederationProviderFactory
called per Keycloak transaction.
getInterface(Class<T>) - Method in class org.keycloak.scripting.InvocableScript
 
getInterface(Object, Class<T>) - Method in class org.keycloak.scripting.InvocableScript
 
getInternalId() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getInternalId() - Method in class org.keycloak.models.IdentityProviderModel
 
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
 
getIpAddress() - Method in interface org.keycloak.models.UserSessionModel
 
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.RealmModel.ClientRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
 
getKeycloakSession() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
 
getKeycloakSessionFactory() - Method in interface org.keycloak.models.KeycloakSession
 
getKeyURI(RealmModel, UserModel, String) - Method in class org.keycloak.models.OTPPolicy
Constructs the otpauth:// URI based on the Key-Uri-Format.
getLabel() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getLastFailure() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getLastFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getLastIPFailure() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getLastIPFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getLastName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getLastName() - Method in class org.keycloak.models.entities.UserEntity
 
getLastName() - Method in interface org.keycloak.models.UserModel
 
getLastName() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getLastSessionRefresh() - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
getLastSessionRefresh() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getLastSessionRefresh() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getLastSessionRefresh() - Method in interface org.keycloak.models.UserSessionModel
 
getLastSync() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getLastSync() - Method in class org.keycloak.models.UserFederationProviderModel
 
getLogic() - Method in interface org.keycloak.authorization.model.Policy
Returns the Policy.Logic for this policy.
getLoginTheme() - Method in class org.keycloak.models.entities.RealmEntity
 
getLoginTheme() - Method in interface org.keycloak.models.RealmModel
 
getLoginUsername() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getLoginUsername() - Method in interface org.keycloak.models.UserSessionModel
 
getLookAheadWindow() - Method in class org.keycloak.models.OTPPolicy
 
getMajor() - Method in class org.keycloak.migration.ModelVersion
 
getManagementUrl() - Method in interface org.keycloak.models.ClientModel
 
getManagementUrl() - Method in class org.keycloak.models.entities.ClientEntity
 
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
getMasterAdminClient() - Method in class org.keycloak.models.entities.RealmEntity
 
getMasterAdminClient() - Method in interface org.keycloak.models.RealmModel
 
getMasterRealmAdminApplicationClientId(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getMaxDeltaTimeSeconds() - Method in class org.keycloak.models.entities.RealmEntity
 
getMaxDeltaTimeSeconds() - Method in interface org.keycloak.models.RealmModel
 
getMaxFailureWaitSeconds() - Method in class org.keycloak.models.entities.RealmEntity
 
getMaxFailureWaitSeconds() - Method in interface org.keycloak.models.RealmModel
 
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.PasswordPolicy.Error
 
getMessage() - Method in class org.keycloak.models.utils.FormMessage
 
getMessageDigest() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
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
 
getMigrationModel() - Method in interface org.keycloak.models.RealmProvider
 
getMimeType() - Method in interface org.keycloak.models.ScriptModel
Returns the MIME-type if the script code, e.g.
getMimeType() - Method in class org.keycloak.scripting.Script
 
getMinimumQuickLoginWaitSeconds() - Method in class org.keycloak.models.entities.RealmEntity
 
getMinimumQuickLoginWaitSeconds() - Method in interface org.keycloak.models.RealmModel
 
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.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.hash.PasswordHashSpi
 
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.ClaimTypeModel
 
getName() - Method in interface org.keycloak.models.ClientModel
 
getName() - Method in interface org.keycloak.models.ClientTemplateModel
 
getName() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getName() - Method in class org.keycloak.models.entities.ClientEntity
 
getName() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getName() - Method in class org.keycloak.models.entities.GroupEntity
 
getName() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getName() - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
getName() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
getName() - Method in class org.keycloak.models.entities.RealmEntity
 
getName() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
getName() - Method in class org.keycloak.models.entities.RoleEntity
 
getName() - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
getName() - Method in interface org.keycloak.models.GroupModel
 
getName() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
getName() - Method in class org.keycloak.models.ProtocolMapperModel
 
getName() - Method in interface org.keycloak.models.RealmModel
 
getName() - Method in class org.keycloak.models.RealmSpi
 
getName() - Method in class org.keycloak.models.RequiredActionProviderModel
Used for display purposes.
getName() - Method in interface org.keycloak.models.RoleModel
 
getName() - Method in interface org.keycloak.models.ScriptModel
Returns the name of the script.
getName() - Method in class org.keycloak.models.session.UserSessionPersisterSpi
 
getName() - Method in class org.keycloak.models.UserFederationMapperModel
 
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.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.provider.ProviderConfigProperty
 
getName() - Method in interface org.keycloak.provider.Spi
 
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.truststore.TruststoreSpi
 
getNodeReRegistrationTimeout() - Method in interface org.keycloak.models.ClientModel
 
getNodeReRegistrationTimeout() - Method in class org.keycloak.models.entities.ClientEntity
 
getNotBefore() - Method in interface org.keycloak.models.ClientModel
Time in seconds since epoc
getNotBefore() - Method in class org.keycloak.models.entities.ClientEntity
 
getNotBefore() - Method in class org.keycloak.models.entities.RealmEntity
 
getNotBefore() - Method in interface org.keycloak.models.RealmModel
Time in seconds since epoc
getNote(String) - Method in interface org.keycloak.models.ClientSessionModel
 
getNote(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getNote(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getNote(String) - Method in interface org.keycloak.models.UserSessionModel
 
getNotes() - Method in interface org.keycloak.models.ClientSessionModel
 
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
 
getNotes() - Method in interface org.keycloak.models.UserSessionModel
 
getNumFailures() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getNumFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getOfflineClientSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineClientSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineSessionIdleTimeout() - Method in class org.keycloak.models.entities.RealmEntity
 
getOfflineSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
 
getOfflineSessionsCount(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getOfflineUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
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
getOTPPolicy() - Method in interface org.keycloak.models.RealmModel
 
getOtpPolicyAlgorithm() - Method in class org.keycloak.models.entities.RealmEntity
 
getOtpPolicyDigits() - Method in class org.keycloak.models.entities.RealmEntity
 
getOtpPolicyInitialCounter() - Method in class org.keycloak.models.entities.RealmEntity
 
getOtpPolicyLookAheadWindow() - Method in class org.keycloak.models.entities.RealmEntity
 
getOtpPolicyPeriod() - Method in class org.keycloak.models.entities.RealmEntity
 
getOtpPolicyType() - Method in class org.keycloak.models.entities.RealmEntity
 
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.PasswordPolicy.Error
 
getParameters() - Method in class org.keycloak.models.utils.FormMessage
 
getParent() - Method in interface org.keycloak.models.GroupModel
 
getParentFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getParentFlow() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
getParentId() - Method in class org.keycloak.models.entities.GroupEntity
 
getParentId() - Method in interface org.keycloak.models.GroupModel
 
getParentName() - Method in interface org.keycloak.theme.Theme
 
getParentPolicy() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getPasswordPolicy() - Method in class org.keycloak.models.entities.RealmEntity
 
getPasswordPolicy() - Method in interface org.keycloak.models.RealmModel
 
getPemFromCertificate(X509Certificate) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPemFromKey(Key) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPeriod() - Method in class org.keycloak.models.entities.CredentialEntity
 
getPeriod() - Method in class org.keycloak.models.OTPPolicy
 
getPeriod() - Method in class org.keycloak.models.UserCredentialValueModel
 
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.
getPostBrokerLoginFlowId() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getPostBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
 
getPriority() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getPriority() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
getPriority() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getPriority() - Method in class org.keycloak.models.UserFederationProviderModel
 
getPrivateKey() - Method in interface org.keycloak.models.RealmModel
 
getPrivateKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPrivateKeyPem() - Method in class org.keycloak.models.entities.RealmEntity
 
getPrivateKeyPem() - Method in interface org.keycloak.models.RealmModel
 
getProperties() - Method in interface org.keycloak.theme.Theme
 
getProtector() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getProtocol() - Method in interface org.keycloak.models.ClientModel
 
getProtocol() - Method in interface org.keycloak.models.ClientTemplateModel
 
getProtocol() - Method in class org.keycloak.models.entities.ClientEntity
 
getProtocol() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getProtocol() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
getProtocol() - Method in class org.keycloak.models.ProtocolMapperModel
 
getProtocol() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getProtocol() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getProtocolMapper() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
getProtocolMapper() - Method in class org.keycloak.models.ProtocolMapperModel
 
getProtocolMapperById(String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProtocolMapperByName(String, String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProtocolMappers() - Method in interface org.keycloak.models.ClientSessionModel
 
getProtocolMappers() - Method in class org.keycloak.models.entities.ClientEntity
 
getProtocolMappers() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getProtocolMappers() - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
getProtocolMappers() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getProtocolMappers() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getProvider(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
 
getProvider(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSession
 
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.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.hash.PasswordHashSpi
 
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.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 interface org.keycloak.provider.Spi
 
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.truststore.TruststoreSpi
 
getProviderFactories() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns the registered PolicyProviderFactory.
getProviderFactories(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getProviderFactory(String) - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a PolicyProviderFactory given a type.
getProviderFactory(Class<T>) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getProviderFactory(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSessionFactory
 
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.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.hash.PasswordHashSpi
 
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.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 interface org.keycloak.provider.Spi
 
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.truststore.TruststoreSpi
 
getProviderId() - Method in class org.keycloak.models.AuthenticationFlowModel
 
getProviderId() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
getProviderId() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
getProviderId() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
getProviderId() - Method in class org.keycloak.models.IdentityProviderModel
 
getProviderId() - Method in class org.keycloak.models.RequiredActionProviderModel
 
getProviderName() - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
getProviderName() - Method in class org.keycloak.models.UserFederationProviderModel
 
getProviderPriority() - Method in interface org.keycloak.theme.ThemeProvider
 
getPublicKey() - Method in interface org.keycloak.models.RealmModel
 
getPublicKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPublicKeyPem() - Method in class org.keycloak.models.entities.RealmEntity
 
getPublicKeyPem() - Method in interface org.keycloak.models.RealmModel
 
getQualifier() - Method in class org.keycloak.migration.ModelVersion
 
getQuickLoginCheckMilliSeconds() - Method in class org.keycloak.models.entities.RealmEntity
 
getQuickLoginCheckMilliSeconds() - Method in interface org.keycloak.models.RealmModel
 
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.broker.provider.AuthenticationRequest
 
getRealm() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getRealm() - Method in interface org.keycloak.models.ClientModel
 
getRealm() - Method in interface org.keycloak.models.ClientSessionModel
 
getRealm() - Method in interface org.keycloak.models.ClientTemplateModel
 
getRealm() - Method in interface org.keycloak.models.KeycloakContext
 
getRealm() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
 
getRealm() - Method in interface org.keycloak.models.RealmModel.UserFederationProviderCreationEvent
 
getRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
getRealm() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRealm() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getRealm() - Method in class org.keycloak.models.UserFederationProviderCreationEventImpl
 
getRealm() - Method in interface org.keycloak.models.UserSessionModel
 
getRealmByName(String) - Method in interface org.keycloak.models.RealmProvider
 
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.models.entities.ClientEntity
 
getRealmId() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getRealmId() - Method in class org.keycloak.models.entities.GroupEntity
 
getRealmId() - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
getRealmId() - Method in class org.keycloak.models.entities.RoleEntity
 
getRealmId() - Method in class org.keycloak.models.entities.UserEntity
 
getRealmId() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getRealmId() - Method in interface org.keycloak.models.ScriptModel
Returns the realm id in which the script was defined.
getRealmId() - Method in class org.keycloak.scripting.Script
 
getRealmManager() - Method in interface org.keycloak.models.KeycloakContext
 
getRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
 
getRealmRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel
 
getRealmRoleMappings() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRealmRoles(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getRealms() - Method in interface org.keycloak.models.RealmProvider
 
getRealmScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel
 
getRedirectUri() - Method in 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 interface org.keycloak.models.ClientSessionModel
 
getRedirectUri() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRedirectUri() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getRedirectUris() - Method in interface org.keycloak.models.ClientModel
 
getRedirectUris() - Method in class org.keycloak.models.entities.ClientEntity
 
getReferenceCategory() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
General authenticator type, i.e.
getRegisteredNodes() - Method in interface org.keycloak.models.ClientModel
 
getRegisteredNodes() - Method in class org.keycloak.models.entities.ClientEntity
 
getRegistrationFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getRegistrationFlow() - Method in interface org.keycloak.models.RealmModel
 
getRegistrationToken() - Method in interface org.keycloak.models.ClientModel
 
getRegistrationToken() - Method in class org.keycloak.models.entities.ClientEntity
 
getRemainingCount() - Method in interface org.keycloak.models.ClientInitialAccessModel
 
getRemoved() - Method in class org.keycloak.models.UserFederationSyncResult
 
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
 
getRequestHeaders() - Method in interface org.keycloak.models.KeycloakContext
 
getRequiredActionProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
getRequiredActionProviderById(String) - Method in interface org.keycloak.models.RealmModel
 
getRequiredActionProviders() - Method in class org.keycloak.models.entities.RealmEntity
 
getRequiredActionProviders() - Method in interface org.keycloak.models.RealmModel
 
getRequiredActions() - Method in interface org.keycloak.models.ClientSessionModel
Required actions that are attached to this client session.
getRequiredActions() - Method in class org.keycloak.models.entities.UserEntity
 
getRequiredActions() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRequiredActions() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getRequiredActions() - Method in interface org.keycloak.models.UserModel
 
getRequiredActions() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRequiredCredentials() - Method in class org.keycloak.models.entities.RealmEntity
 
getRequiredCredentials() - Method in interface org.keycloak.models.RealmModel
 
getRequirement() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
getRequirement() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
getRequirementChoices() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
What requirement settings are allowed.
getResetCredentialsFlow() - Method in class org.keycloak.models.entities.RealmEntity
 
getResetCredentialsFlow() - Method in interface org.keycloak.models.RealmModel
 
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.
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
 
getRole(String) - Method in interface org.keycloak.models.RoleContainerModel
 
getRole() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
 
getRoleById(String) - Method in interface org.keycloak.models.RealmModel
 
getRoleById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getRoleFromString(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getRoleIds() - Method in class org.keycloak.models.entities.GroupEntity
 
getRoleIds() - Method in class org.keycloak.models.entities.UserEntity
 
getRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel
 
getRoleMappings() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getRoles() - Method in interface org.keycloak.models.ClientSessionModel
 
getRoles() - Method in interface org.keycloak.models.RoleContainerModel
 
getRoles() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getRoles() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
 
getRootUrl() - Method in interface org.keycloak.models.ClientModel
 
getRootUrl() - Method in class org.keycloak.models.entities.ClientEntity
 
getSalt() - Method in class org.keycloak.models.entities.CredentialEntity
 
getSalt() - Method in class org.keycloak.models.UserCredentialValueModel
 
getScopeIds() - Method in class org.keycloak.models.entities.ClientEntity
 
getScopeIds() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
getScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel
 
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.
getSecret() - Method in interface org.keycloak.models.ClientModel
 
getSecret() - Method in class org.keycloak.models.entities.ClientEntity
 
getSecretKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getServerStartupTimestamp() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getServiceAccountClientLink() - Method in class org.keycloak.models.entities.UserEntity
 
getServiceAccountClientLink() - Method in interface org.keycloak.models.UserModel
 
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.
getSmtpConfig() - Method in class org.keycloak.models.entities.RealmEntity
 
getSmtpConfig() - Method in interface org.keycloak.models.RealmModel
 
getSocialConfig() - Method in class org.keycloak.models.entities.RealmEntity
 
getSpis() - Method in interface org.keycloak.models.KeycloakSessionFactory
 
getSslRequired() - Method in class org.keycloak.models.entities.RealmEntity
 
getSslRequired() - Method in interface org.keycloak.models.RealmModel
 
getSsoSessionIdleTimeout() - Method in class org.keycloak.models.entities.RealmEntity
 
getSsoSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
 
getSsoSessionMaxLifespan() - Method in class org.keycloak.models.entities.RealmEntity
 
getSsoSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
 
getStarted() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getStarted() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getStarted() - Method in interface org.keycloak.models.UserSessionModel
 
getState() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getState() - Method in class org.keycloak.models.CredentialValidationOutput
 
getState() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getState() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
getState() - Method in interface org.keycloak.models.UserSessionModel
 
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
 
getStatus() - Method in class org.keycloak.models.UserFederationSyncResult
 
getStoredVersion() - Method in interface org.keycloak.migration.MigrationModel
 
getStoreFactory() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a StoreFactory.
getStrength() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
getSubGroups() - Method in interface org.keycloak.models.GroupModel
 
getSuccessMessage() - Method in exception org.keycloak.authentication.ForkFlowException
 
getSupportedCredentialTypes(UserModel) - Method in interface org.keycloak.models.UserFederationProvider
What UserCredentialModel types should be handled by this provider for this user? Keycloak will only call validCredentials() with the credential types specified in this method.
getSupportedCredentialTypes() - Method in interface org.keycloak.models.UserFederationProvider
What UserCredentialModel types should be handled by this provider? This is called in scenarios when we don't know user, who is going to authenticate (For example Kerberos authentication).
getSupportedLocales() - Method in class org.keycloak.models.entities.RealmEntity
 
getSupportedLocales() - Method in interface org.keycloak.models.RealmModel
 
getSyncConfig() - Method in interface org.keycloak.mappers.UserFederationMapperFactory
Specifies if mapper supports sync data from federation 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 interface org.keycloak.models.ClientInitialAccessModel
 
getTimestamp() - Method in interface org.keycloak.models.ClientSessionModel
 
getTimestamp() - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
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
 
getToken() - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
getToken() - Method in class org.keycloak.models.FederatedIdentityModel
 
getTopLevelGroups() - Method in interface org.keycloak.models.RealmModel
 
getTopLevelGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
getTransaction() - Method in interface org.keycloak.models.KeycloakSession
 
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 class org.keycloak.models.ClaimTypeModel
 
getType() - Method in class org.keycloak.models.entities.CredentialEntity
 
getType() - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
getType() - Method in class org.keycloak.models.OTPPolicy
 
getType() - Method in class org.keycloak.models.RequiredCredentialModel
 
getType() - Method in class org.keycloak.models.UserCredentialModel
 
getType() - Method in class org.keycloak.models.UserCredentialValueModel
 
getType() - Method in class org.keycloak.provider.ProviderConfigProperty
 
getType() - Method in interface org.keycloak.theme.Theme
 
getUpdated() - Method in class org.keycloak.models.UserFederationSyncResult
 
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.
getUri() - Method in interface org.keycloak.models.KeycloakContext
 
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.entities.CredentialEntity
 
getUser() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
getUser() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
 
getUser() - Method in interface org.keycloak.models.UserSessionModel
 
getUserAttribute(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getUserByEmail(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByEmail(RealmModel, String) - Method in interface org.keycloak.models.UserFederationProvider
Keycloak will search for user in local storage first.
getUserByEmail(String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserById(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserById(String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserByServiceAccountClient(ClientModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByServiceAccountClient(ClientModel) - Method in interface org.keycloak.models.UserProvider
 
getUserByUsername(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUserByUsername(RealmModel, String) - Method in interface org.keycloak.models.UserFederationProvider
Keycloak will search for user in local storage first.
getUserByUsername(String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserFederationMapperById(String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMappers() - Method in class org.keycloak.models.entities.RealmEntity
 
getUserFederationMappers() - Method in interface org.keycloak.models.RealmModel
 
getUserFederationMappersByFederationProvider(String) - Method in interface org.keycloak.models.RealmModel
 
getUserFederationProviders() - Method in class org.keycloak.models.entities.RealmEntity
 
getUserFederationProviders() - Method in interface org.keycloak.models.RealmModel
 
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.entities.FederatedIdentityEntity
 
getUserId() - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
getUserId() - Method in class org.keycloak.models.entities.UserConsentEntity
 
getUserId() - Method in class org.keycloak.models.FederatedIdentityModel
 
getUserId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getUserId() - Method in interface org.keycloak.models.UserLoginFailureModel
 
getUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUsername() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Username in remote idp
getUserName() - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
getUsername() - Method in class org.keycloak.models.entities.UserEntity
 
getUsername() - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
getUserName() - Method in class org.keycloak.models.FederatedIdentityModel
 
getUsername() - Method in interface org.keycloak.models.UserModel
 
getUsername() - Method in class org.keycloak.models.utils.UserModelDelegate
 
getUsers(RealmModel, boolean) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel, int, int, boolean) - Method in class org.keycloak.models.UserFederationManager
 
getUsers(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider
 
getUsers(RealmModel, int, int, boolean) - Method in interface org.keycloak.models.UserProvider
 
getUsersCount(RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
getUsersCount(RealmModel) - Method in interface org.keycloak.models.UserProvider
 
getUserSession() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getUserSession() - Method in interface org.keycloak.models.ClientSessionModel
 
getUserSession() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionByBrokerSessionId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionByBrokerUserId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessionId() - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
getUserSessionId() - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
getUserSessionNotes() - Method in interface org.keycloak.models.ClientSessionModel
These are notes you want applied to the UserSessionModel when the client session is attached to it.
getUserSessionNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
getUserSessionNotes() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
getUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
getUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider
 
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() - Method in class org.keycloak.models.entities.CredentialEntity
 
getValue() - Method in class org.keycloak.models.UserCredentialModel
 
getValue() - Method in class org.keycloak.models.UserCredentialValueModel
 
getValue(Object) - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property value for the specified bean.
getWaitIncrementSeconds() - Method in class org.keycloak.models.entities.RealmEntity
 
getWaitIncrementSeconds() - Method in interface org.keycloak.models.RealmModel
 
getWebOrigins() - Method in interface org.keycloak.models.ClientModel
 
getWebOrigins() - Method in class org.keycloak.models.entities.ClientEntity
 
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 interface org.keycloak.models.RoleMapperModel
 
grantRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
grantToAllUsers(RealmModel, RoleModel) - Method in class org.keycloak.models.UserFederationManager
 
grantToAllUsers(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserProvider
 
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
 
GroupEntity - Class in org.keycloak.models.entities
 
GroupEntity() - Constructor for class org.keycloak.models.entities.GroupEntity
 
GroupModel - Interface in org.keycloak.models
 

H

hasAddress(long) - Static method in class org.keycloak.models.ClaimMask
 
hasEmail(long) - Static method in class org.keycloak.models.ClaimMask
 
hasFunction(String) - Method in class org.keycloak.scripting.InvocableScript
Returns true iif the ScriptEngine has a function with the given functionName.
hasGender(long) - Static method in class org.keycloak.models.ClaimMask
 
hashCode() - Method in class org.keycloak.models.ClaimTypeModel
 
hashCode() - Method in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
hashCode() - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
hashCode() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
hashCode() - Method in class org.keycloak.models.IdentityProviderMapperModel
 
hashCode() - Method in class org.keycloak.models.ProtocolMapperModel
 
hashCode() - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
hashCode() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
hashCode() - Method in class org.keycloak.models.UserFederationMapperModel
 
hashIterations - Variable in class org.keycloak.models.entities.CredentialEntity
 
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
 
hasRole(String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a role with the given roleName.
hasRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
 
hasRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
hasRole(Set<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
hasRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
hasScope(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
 
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
 
helpText - Variable in class org.keycloak.provider.ProviderConfigProperty
 
HMAC_SHA1 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HMAC_SHA256 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HMAC_SHA512 - Static variable in class org.keycloak.models.utils.HmacOTP
 
HmacOTP - Class in org.keycloak.models.utils
 
HmacOTP(int, String, int) - Constructor for class org.keycloak.models.utils.HmacOTP
 
HostnameVerificationPolicy - Enum in org.keycloak.truststore
 
hostnameVerifier(HostnameVerifier) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
HOTP - Static variable in class org.keycloak.models.UserCredentialModel
 
hotp(String) - Static method in class org.keycloak.models.UserCredentialModel
 
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.hash.Pbkdf2PasswordHashProvider
 
id - Variable in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
id - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
id - Variable in class org.keycloak.models.ProtocolMapperModel
 
ID - Static variable in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
id - Variable in class org.keycloak.models.UserFederationMapperModel
 
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
 
identityProviderAlias - Variable in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
identityProviderAlias - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
IdentityProviderDataMarshaller - Interface in org.keycloak.broker.provider
 
IdentityProviderEntity - Class in org.keycloak.models.entities
 
IdentityProviderEntity() - Constructor for class org.keycloak.models.entities.IdentityProviderEntity
 
IdentityProviderFactory<T extends IdentityProvider> - Interface in org.keycloak.broker.provider
 
IdentityProviderMapper - Interface in org.keycloak.broker.provider
 
identityProviderMapper - Variable in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
identityProviderMapper - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
IdentityProviderMapperEntity - Class in org.keycloak.models.entities
 
IdentityProviderMapperEntity() - Constructor for class org.keycloak.models.entities.IdentityProviderMapperEntity
 
IdentityProviderMapperModel - Class in org.keycloak.models
Specifies a mapping from broker login to user data.
IdentityProviderMapperModel() - Constructor for class org.keycloak.models.IdentityProviderMapperModel
 
IdentityProviderMapperSpi - Class in org.keycloak.broker.provider
 
IdentityProviderMapperSpi() - Constructor for class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
IdentityProviderModel - Class in org.keycloak.models
A model type representing the configuration for identity providers.
IdentityProviderModel() - Constructor for class org.keycloak.models.IdentityProviderModel
 
IdentityProviderModel(IdentityProviderModel) - Constructor for class org.keycloak.models.IdentityProviderModel
 
identityProviders - Variable in class org.keycloak.models.entities.ClientEntity
 
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.
ignored() - Static method in class org.keycloak.models.UserFederationSyncResult
 
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
 
implicitFlowEnabled - Variable in class org.keycloak.models.entities.ClientEntity
 
implicitFlowEnabled - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
importAuthenticationFlows(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importClientSession(ClientSessionModel, boolean) - Method in interface org.keycloak.models.UserSessionProvider
 
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
 
importUserSession(UserSessionModel, boolean) - Method in interface org.keycloak.models.UserSessionProvider
 
increaseAdded() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseFailed() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseRemoved() - Method in class org.keycloak.models.UserFederationSyncResult
 
increaseUpdated() - Method in class org.keycloak.models.UserFederationSyncResult
 
incrementFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
 
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 class org.keycloak.hash.Pbkdf2PasswordHashProvider
 
init(Config.Scope) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
init(Config.Scope) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
init(Config.Scope) - Method in interface org.keycloak.provider.ProviderFactory
Only called once when the factory is first created.
initialCounter - Variable in class org.keycloak.models.OTPPolicy
 
input - Variable in class org.keycloak.models.RequiredCredentialModel
 
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_PASSWORD_HISTORY - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_MIN_DIGITS_MESSAGE - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_MIN_LENGTH_MESSAGE - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_MIN_LOWER_CASE_CHARS_MESSAGE - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_MIN_SPECIAL_CHARS_MESSAGE - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_MIN_UPPER_CASE_CHARS_MESSAGE - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_NOT_USERNAME - Static variable in class org.keycloak.models.PasswordPolicy
 
INVALID_PASSWORD_REGEX_PATTERN - Static variable in class org.keycloak.models.PasswordPolicy
 
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
 
InvocableScript - Class in org.keycloak.scripting
 
InvocableScript(ScriptModel, ScriptEngine) - Constructor for class org.keycloak.scripting.InvocableScript
 
invokeFunction(String, Object...) - Method in class org.keycloak.scripting.InvocableScript
 
invokeMethod(Object, String, Object...) - Method in class org.keycloak.scripting.InvocableScript
 
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
 
isActive() - Method in interface org.keycloak.models.KeycloakTransaction
 
isAddReadTokenRoleOnCreate() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
isAddReadTokenRoleOnCreate() - Method in class org.keycloak.models.IdentityProviderModel
 
isAdminEventsDetailsEnabled() - Method in class org.keycloak.models.entities.RealmEntity
 
isAdminEventsDetailsEnabled() - Method in interface org.keycloak.models.RealmModel
 
isAdminEventsEnabled() - Method in class org.keycloak.models.entities.RealmEntity
 
isAdminEventsEnabled() - Method in interface org.keycloak.models.RealmModel
 
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.
isAlternative() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isAnnotationPresent(Class<? extends Annotation>) - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether the given annotation is defined for this property.
isAuthenticateByDefault() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
isAuthenticateByDefault() - Method in class org.keycloak.models.IdentityProviderModel
 
isAuthenticatorFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
Is the referenced authenticator a flow?
isAuthenticatorFlow() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
isBearerOnly() - Method in interface org.keycloak.models.ClientModel
 
isBearerOnly() - Method in interface org.keycloak.models.ClientTemplateModel
 
isBearerOnly() - Method in class org.keycloak.models.entities.ClientEntity
 
isBearerOnly() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isBruteForceProtected() - Method in class org.keycloak.models.entities.RealmEntity
 
isBruteForceProtected() - Method in interface org.keycloak.models.RealmModel
 
isBuiltIn() - Method in class org.keycloak.models.AuthenticationFlowModel
 
isBuiltIn() - Method in class org.keycloak.models.ClaimTypeModel
 
isBuiltIn() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
isClientRole() - Method in interface org.keycloak.models.RoleModel
 
isClientSessionNotFound() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
isClientTemplateUsed(RealmModel, ClientTemplateModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
isComposite() - Method in interface org.keycloak.models.RoleModel
 
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?
isConsentRequired() - Method in interface org.keycloak.models.ClientModel
 
isConsentRequired() - Method in interface org.keycloak.models.ClientTemplateModel
 
isConsentRequired() - Method in class org.keycloak.models.entities.ClientEntity
 
isConsentRequired() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isConsentRequired() - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
isConsentRequired() - Method in class org.keycloak.models.ProtocolMapperModel
 
isDefaultAction() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
isDefaultAction() - Method in class org.keycloak.models.RequiredActionProviderModel
 
isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientModel
 
isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isDirectAccessGrantsEnabled() - Method in class org.keycloak.models.entities.ClientEntity
 
isDirectAccessGrantsEnabled() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isDisabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isDownloadOnly() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
isEditUsernameAllowed() - Method in class org.keycloak.models.entities.RealmEntity
 
isEditUsernameAllowed() - Method in interface org.keycloak.models.RealmModel
 
isEmailVerified() - Method in class org.keycloak.models.entities.UserEntity
 
isEmailVerified() - Method in interface org.keycloak.models.UserModel
 
isEmailVerified() - Method in class org.keycloak.models.utils.UserModelDelegate
 
isEnabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isEnabled() - Method in interface org.keycloak.models.ClientModel
 
isEnabled() - Method in class org.keycloak.models.entities.ClientEntity
 
isEnabled() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
isEnabled() - Method in class org.keycloak.models.entities.RealmEntity
 
isEnabled() - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
isEnabled() - Method in class org.keycloak.models.entities.UserEntity
 
isEnabled() - Method in class org.keycloak.models.IdentityProviderModel
 
isEnabled() - Method in interface org.keycloak.models.RealmModel
 
isEnabled() - Method in class org.keycloak.models.RequiredActionProviderModel
 
isEnabled() - Method in interface org.keycloak.models.UserModel
 
isEnabled() - Method in class org.keycloak.models.utils.UserModelDelegate
 
isEventsEnabled() - Method in class org.keycloak.models.entities.RealmEntity
 
isEventsEnabled() - Method in interface org.keycloak.models.RealmModel
 
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
 
isFrontchannelLogout() - Method in interface org.keycloak.models.ClientModel
 
isFrontchannelLogout() - Method in interface org.keycloak.models.ClientTemplateModel
 
isFrontchannelLogout() - Method in class org.keycloak.models.entities.ClientEntity
 
isFrontchannelLogout() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isFullScopeAllowed() - Method in class org.keycloak.models.entities.ClientEntity
 
isFullScopeAllowed() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isFullScopeAllowed() - Method in interface org.keycloak.models.ScopeContainerModel
 
isIdentityFederationEnabled() - Method in interface org.keycloak.models.RealmModel
 
isIgnored() - Method in class org.keycloak.models.UserFederationSyncResult
 
isIllegalHash() - Method in class org.keycloak.services.managers.ClientSessionCode.ParseResult
 
isImplicitFlowEnabled() - Method in interface org.keycloak.models.ClientModel
 
isImplicitFlowEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isImplicitFlowEnabled() - Method in class org.keycloak.models.entities.ClientEntity
 
isImplicitFlowEnabled() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isInput() - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
isInput() - Method in class org.keycloak.models.RequiredCredentialModel
 
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.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.hash.PasswordHashSpi
 
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.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 interface org.keycloak.provider.Spi
 
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.truststore.TruststoreSpi
 
isInternationalizationEnabled() - Method in class org.keycloak.models.entities.RealmEntity
 
isInternationalizationEnabled() - Method in interface org.keycloak.models.RealmModel
 
isMasterRealmExported() - Method in interface org.keycloak.exportimport.ImportProvider
 
isMember(Set<GroupModel>, GroupModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
isMemberOf(GroupModel) - Method in interface org.keycloak.models.UserModel
 
isMemberOf(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
isOptional() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isOtp(String) - Static method in class org.keycloak.models.UserCredentialModel
 
isOtpEnabled() - Method in interface org.keycloak.models.UserModel
 
isOtpEnabled() - Method in class org.keycloak.models.utils.UserModelDelegate
 
isProperty(Method) - Static method in class org.keycloak.models.utils.reflection.Properties
Indicates whether this method is a valid property method.
isProtocolMapperGranted(ProtocolMapperModel) - Method in class org.keycloak.models.UserConsentModel
 
isPublicClient() - Method in interface org.keycloak.models.ClientModel
 
isPublicClient() - Method in interface org.keycloak.models.ClientTemplateModel
 
isPublicClient() - Method in class org.keycloak.models.entities.ClientEntity
 
isPublicClient() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isReadOnly() - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether this is a read-only property
isRegistrationAllowed() - Method in class org.keycloak.models.entities.RealmEntity
 
isRegistrationAllowed() - Method in interface org.keycloak.models.RealmModel
 
isRegistrationEmailAsUsername() - Method in class org.keycloak.models.entities.RealmEntity
 
isRegistrationEmailAsUsername() - Method in interface org.keycloak.models.RealmModel
 
isRememberMe() - Method in class org.keycloak.models.entities.RealmEntity
 
isRememberMe() - Method in interface org.keycloak.models.RealmModel
 
isRememberMe() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
isRememberMe() - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
isRememberMe() - Method in interface org.keycloak.models.UserSessionModel
 
isRequired() - Method in class org.keycloak.models.AuthenticationExecutionModel
 
isResetPasswordAllowed() - Method in class org.keycloak.models.entities.RealmEntity
 
isResetPasswordAllowed() - Method in interface org.keycloak.models.RealmModel
 
isRetrieveToken() - Method in class org.keycloak.models.entities.ClientIdentityProviderMappingEntity
 
isRevokeRefreshToken() - Method in class org.keycloak.models.entities.RealmEntity
 
isRevokeRefreshToken() - Method in interface org.keycloak.models.RealmModel
 
isRoleGranted(RoleModel) - Method in class org.keycloak.models.UserConsentModel
 
isSaveByDefault() - Method in enum org.keycloak.events.EventType
 
isScopeParamRequired() - Method in class org.keycloak.models.entities.RoleEntity
 
isScopeParamRequired() - Method in interface org.keycloak.models.RoleModel
 
isSecret() - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
isSecret() - Method in class org.keycloak.models.RequiredCredentialModel
 
isServiceAccountsEnabled() - Method in interface org.keycloak.models.ClientModel
 
isServiceAccountsEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isServiceAccountsEnabled() - Method in class org.keycloak.models.entities.ClientEntity
 
isServiceAccountsEnabled() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isStandardFlowEnabled() - Method in interface org.keycloak.models.ClientModel
 
isStandardFlowEnabled() - Method in interface org.keycloak.models.ClientTemplateModel
 
isStandardFlowEnabled() - Method in class org.keycloak.models.entities.ClientEntity
 
isStandardFlowEnabled() - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
isStoreToken() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
isStoreToken() - Method in class org.keycloak.models.IdentityProviderModel
 
isSurrogateAuthRequired() - Method in interface org.keycloak.models.ClientModel
 
isSurrogateAuthRequired() - Method in class org.keycloak.models.entities.ClientEntity
 
isTemporarilyDisabled(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
isTopLevel() - Method in class org.keycloak.models.AuthenticationFlowModel
 
isTopLevel() - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
isTotp() - Method in class org.keycloak.models.entities.UserEntity
 
isTrustEmail() - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
isTrustEmail() - Method in class org.keycloak.models.IdentityProviderModel
 
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?
isUserSetupAllowed() - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
isUseTemplateConfig() - Method in class org.keycloak.models.entities.ClientEntity
 
isUseTemplateMappers() - Method in class org.keycloak.models.entities.ClientEntity
 
isUseTemplateScope() - Method in class org.keycloak.models.entities.ClientEntity
 
isValid(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Is the Keycloak UserModel still valid and/or existing in federated storage? Keycloak may call this method in various user operations.
isValid(String, ClientSessionCode.ActionType) - Method in class org.keycloak.services.managers.ClientSessionCode
 
isValidAction(String) - Method in class org.keycloak.services.managers.ClientSessionCode
 
isVerifyEmail() - Method in class org.keycloak.models.entities.RealmEntity
 
isVerifyEmail() - Method in interface org.keycloak.models.RealmModel
 

J

joinGroup(GroupModel) - Method in interface org.keycloak.models.UserModel
 
joinGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 

K

KERBEROS - Static variable in class org.keycloak.models.RequiredCredentialModel
 
KERBEROS - Static variable in class org.keycloak.models.UserCredentialModel
 
kerberos(String) - Static method in class org.keycloak.models.UserCredentialModel
 
KEY - Static variable in interface org.keycloak.models.Constants
 
KeycloakContext - Interface in org.keycloak.models
 
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.
KeycloakSession - Interface in org.keycloak.models
 
KeycloakSessionFactory - Interface in org.keycloak.models
 
KeycloakSessionTask - Interface in org.keycloak.models
Task to be executed inside transaction
KeycloakTransaction - Interface in org.keycloak.models
 
KeycloakTransactionManager - Interface in org.keycloak.models
 

L

label - Variable in class org.keycloak.provider.ProviderConfigProperty
 
LAST_NAME - Static variable in interface org.keycloak.models.UserFederationProvider
 
LAST_NAME - Static variable in interface org.keycloak.models.UserModel
 
LATEST_VERSION - Static variable in interface org.keycloak.migration.MigrationModel
Must have the form of major.minor.micro as the version is parsed and numbers are compared
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 interface org.keycloak.models.UserModel
 
leaveGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
lessThan(ModelVersion) - Method in class org.keycloak.migration.ModelVersion
 
LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
listClientInitialAccess(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
listProviderIds(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
 
load(Spi) - Method in interface org.keycloak.provider.ProviderLoader
Load all provider factories of a specific SPI.
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
 
LOCALE - Static variable in interface org.keycloak.models.UserModel
 
logger - Static variable in class org.keycloak.models.dblock.DBLockManager
 
logger - Static variable in class org.keycloak.models.OTPPolicy
 
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
 
lookAheadWindow - Variable in class org.keycloak.models.OTPPolicy
 
lookAheadWindow - Variable in class org.keycloak.models.utils.HmacOTP
 

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
 
managementUrl - Variable in class org.keycloak.models.entities.ClientEntity
 
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
 
merge(CredentialValidationOutput) - Method in class org.keycloak.models.CredentialValidationOutput
 
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_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.MigrationTo1_2_0_CR1
 
migrateFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
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
 
MigrationModel - Interface in org.keycloak.migration
 
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
 
MigrationTo1_2_0_CR1 - Class in org.keycloak.migration.migrators
 
MigrationTo1_2_0_CR1() - Constructor for class org.keycloak.migration.migrators.MigrationTo1_2_0_CR1
 
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
 
moveGroup(GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmModel
 
moveGroup(RealmModel, GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
MSAD_USER_ACCOUNT_CONTROL_MAPPER - Static variable in class org.keycloak.models.LDAPConstants
 

N

NAME - Static variable in class org.keycloak.models.ClaimMask
 
name - Variable in class org.keycloak.models.entities.ClientEntity
 
name - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
name - Variable in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
name - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
name - Variable in class org.keycloak.models.entities.RequiredActionProviderEntity
 
name - Variable in class org.keycloak.models.entities.UserFederationMapperEntity
 
name - Variable in class org.keycloak.models.IdentityProviderMapperModel
 
name - Variable in class org.keycloak.models.ProtocolMapperModel
 
name - Variable in class org.keycloak.models.UserFederationMapperModel
 
NAME - Static variable in class org.keycloak.models.UserSessionSpi
 
name - Variable in class org.keycloak.provider.ProviderConfigProperty
 
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
 
nodeReRegistrationTimeout - Variable in class org.keycloak.models.entities.ClientEntity
 
NOT_ALLOWED - Static variable in interface org.keycloak.events.Errors
 
notBefore - Variable in class org.keycloak.models.entities.ClientEntity
 
notExecuted() - Static method in class org.keycloak.cluster.ExecutionResult
 
notify(String, ClusterEvent) - Method in interface org.keycloak.cluster.ClusterProvider
Notify registered listeners on all cluster nodes
numberDigits - Variable in class org.keycloak.models.utils.HmacOTP
 

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
 
onClientRemoved(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
 
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
 
onEvent(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventListener
 
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
 
onRealmRemoved(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
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
 
onUserRemoved(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
operation(OperationType...) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by operation type
OperationType - Enum in org.keycloak.events.admin
 
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.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.hash - package org.keycloak.hash
 
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.entities - package org.keycloak.models.entities
 
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.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.truststore - package org.keycloak.truststore
 
otp(String, String) - Static method in class org.keycloak.models.UserCredentialModel
 
OTPPolicy - Class in org.keycloak.models
 
OTPPolicy() - Constructor for class org.keycloak.models.OTPPolicy
 
OTPPolicy(String, String, int, int, int, int) - Constructor for class org.keycloak.models.OTPPolicy
 
otpPolicyAlgorithm - Variable in class org.keycloak.models.entities.RealmEntity
 
otpPolicyDigits - Variable in class org.keycloak.models.entities.RealmEntity
 
otpPolicyInitialCounter - Variable in class org.keycloak.models.entities.RealmEntity
 
otpPolicyLookAheadWindow - Variable in class org.keycloak.models.entities.RealmEntity
 
otpPolicyPeriod - Variable in class org.keycloak.models.entities.RealmEntity
 
otpPolicyType - Variable in class org.keycloak.models.entities.RealmEntity
 

P

PAGINATION - Static variable in class org.keycloak.models.LDAPConstants
 
param(String, String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
parentFlow - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
parse(String, KeycloakSession) - Static method in class org.keycloak.services.managers.ClientSessionCode
 
parse(String, KeycloakSession, RealmModel) - Static method in class org.keycloak.services.managers.ClientSessionCode
 
parseConfig(InputStream) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
parseConfig(InputStream) - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates an IdentityProvider based on the configuration from inputStream.
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 - Static variable in class org.keycloak.models.RequiredCredentialModel
 
PASSWORD - Static variable in class org.keycloak.models.UserCredentialModel
 
password(String) - Static method in class org.keycloak.models.UserCredentialModel
 
PASSWORD - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
PASSWORD_HISTORY - Static variable in class org.keycloak.models.UserCredentialModel
 
PASSWORD_TOKEN - Static variable in class org.keycloak.models.UserCredentialModel
 
PasswordHashManager - Class in org.keycloak.hash
 
PasswordHashManager() - Constructor for class org.keycloak.hash.PasswordHashManager
 
PasswordHashProvider - Interface in org.keycloak.hash
 
PasswordHashProviderFactory - Interface in org.keycloak.hash
 
PasswordHashSpi - Class in org.keycloak.hash
 
PasswordHashSpi() - Constructor for class org.keycloak.hash.PasswordHashSpi
 
PasswordPolicy - Class in org.keycloak.models
 
PasswordPolicy(String) - Constructor for class org.keycloak.models.PasswordPolicy
 
PasswordPolicy.Error - Class in org.keycloak.models
 
passwordToken(String) - Static method in class org.keycloak.models.UserCredentialModel
 
Pbkdf2PasswordHashProvider - Class in org.keycloak.hash
 
Pbkdf2PasswordHashProvider() - Constructor for class org.keycloak.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.
period - Variable in class org.keycloak.models.entities.CredentialEntity
 
period - Variable in class org.keycloak.models.OTPPolicy
 
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
 
PersistentClientSessionEntity - Class in org.keycloak.models.entities
 
PersistentClientSessionEntity() - Constructor for class org.keycloak.models.entities.PersistentClientSessionEntity
 
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
 
PersistentUserSessionEntity - Class in org.keycloak.models.entities
 
PersistentUserSessionEntity() - Constructor for class org.keycloak.models.entities.PersistentUserSessionEntity
 
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
 
Policy.DecisionStrategy - Enum in org.keycloak.authorization.model
The decision strategy dictates how the policies associated with a given policy are evaluated and how a final decision is obtained.
Policy.Logic - Enum in org.keycloak.authorization.model
The decision strategy dictates how the policies associated with a given policy are evaluated and how a final decision is obtained.
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 class org.keycloak.hash.Pbkdf2PasswordHashProvider
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.UserFederationEventAwareProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.provider.ProviderFactory
Called after all provider factories have been initialized
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
prepareScript(ScriptModel, ScriptBindingsConfigurer) - Method in interface org.keycloak.scripting.ScriptingProvider
Returns an InvocableScript based on the given ScriptModel.
prepareScript(ScriptModel) - Method in interface org.keycloak.scripting.ScriptingProvider
Returns an InvocableScript based on the given ScriptModel with an ScriptBindingsConfigurer.EMPTY ScriptBindingsConfigurer.
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.
preRemove(RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, UserFederationProviderModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, GroupModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, RoleModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel, ClientModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(ProtocolMapperModel) - Method in class org.keycloak.models.UserFederationManager
 
preRemove(RealmModel) - Method in interface org.keycloak.models.UserFederationProvider
called whenever a Realm is removed
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserFederationProvider
called before a role is removed.
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserFederationProvider
called before a role is removed.
preRemove(RealmModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, UserFederationProviderModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserProvider
 
preRemove(ProtocolMapperModel) - Method in interface org.keycloak.models.UserProvider
 
PREVIOUS_EMAIL - Static variable in interface org.keycloak.events.Details
 
priority - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
priority - Variable in class org.keycloak.models.entities.UserFederationProviderEntity
 
PRIVATE_KEY - Static variable in interface org.keycloak.models.ClientModel
 
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.
protocol - Variable in class org.keycloak.models.entities.ClientEntity
 
protocol - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
protocol - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
protocol - Variable in class org.keycloak.models.ProtocolMapperModel
 
protocolMapper - Variable in class org.keycloak.models.entities.ProtocolMapperEntity
 
protocolMapper - Variable in class org.keycloak.models.ProtocolMapperModel
 
ProtocolMapper - Interface in org.keycloak.protocol
 
ProtocolMapperContainerModel - Interface in org.keycloak.models
 
ProtocolMapperEntity - Class in org.keycloak.models.entities
 
ProtocolMapperEntity() - Constructor for class org.keycloak.models.entities.ProtocolMapperEntity
 
ProtocolMapperModel - Class in org.keycloak.models
Specifies a mapping from user data to a protocol claim assertion.
ProtocolMapperModel() - Constructor for class org.keycloak.models.ProtocolMapperModel
 
protocolMappers - Variable in class org.keycloak.models.entities.ClientEntity
 
protocolMappers - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
ProtocolMapperSpi - Class in org.keycloak.protocol
 
ProtocolMapperSpi() - Constructor for class org.keycloak.protocol.ProtocolMapperSpi
 
Provider - Interface in org.keycloak.provider
 
ProviderConfigProperty - Class in org.keycloak.provider
 
ProviderConfigProperty() - Constructor for class org.keycloak.provider.ProviderConfigProperty
 
ProviderEvent - Interface in org.keycloak.provider
 
ProviderEventListener - Interface in org.keycloak.provider
 
ProviderEventManager - Interface in org.keycloak.provider
 
ProviderFactory<T extends Provider> - Interface in org.keycloak.provider
At boot time, keycloak discovers all factories.
providerId - Variable in class org.keycloak.models.entities.AuthenticationFlowEntity
 
providerId - Variable in class org.keycloak.models.entities.RequiredActionProviderEntity
 
ProviderLoader - Interface in org.keycloak.provider
 
ProviderLoaderFactory - Interface in org.keycloak.provider
 
providerName - Variable in class org.keycloak.models.entities.UserFederationProviderEntity
 
PUBLIC_KEY - Static variable in interface org.keycloak.models.ClientModel
 
publicClient - Variable in class org.keycloak.models.entities.ClientEntity
 
publicClient - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
publish(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventManager
 
PWD_LAST_SET - Static variable in class org.keycloak.models.LDAPConstants
 

Q

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

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
 
RealmEntity - Class in org.keycloak.models.entities
 
RealmEntity() - Constructor for class org.keycloak.models.entities.RealmEntity
 
realmId - Variable in class org.keycloak.models.entities.ClientEntity
 
realmId - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
RealmModel - Interface in org.keycloak.models
 
RealmModel.ClientCreationEvent - Interface in org.keycloak.models
 
RealmModel.ClientRemovedEvent - Interface in org.keycloak.models
 
RealmModel.RealmCreationEvent - Interface in org.keycloak.models
 
RealmModel.RealmRemovedEvent - Interface in org.keycloak.models
 
RealmModel.UserFederationProviderCreationEvent - Interface in org.keycloak.models
 
RealmProvider - Interface in org.keycloak.models
 
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
 
realms() - Method in interface org.keycloak.models.KeycloakSession
Returns a managed provider instance.
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
 
redirectUris - Variable in class org.keycloak.models.entities.ClientEntity
 
REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
REFRESH_TOKEN_TYPE - Static variable in interface org.keycloak.events.Details
 
register(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Called if this federation provider has priority and supports synchronized registrations.
register(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
 
REGISTER_METHOD - Static variable in interface org.keycloak.events.Details
 
registerClientInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerClientTemplateInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registeredNodes - Variable in class org.keycloak.models.entities.ClientEntity
 
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.
registerNode(String, int) - Method in interface org.keycloak.models.ClientModel
Register node or just update the 'lastReRegistration' time if this node is already registered
registerRealmInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerRoleInvalidation(String) - Method in interface org.keycloak.models.cache.CacheRealmProvider
 
registerSynchronizationListeners(KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.AuthorizationStoreFactory
 
registerWithFederation(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
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
 
registrationEmailAsUsername - Variable in class org.keycloak.models.entities.RealmEntity
 
registrationFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
registrationToken - Variable in class org.keycloak.models.entities.ClientEntity
 
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
 
removeAllUserLoginFailures(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeAssociatedPolicy(Policy) - Method in interface org.keycloak.authorization.model.Policy
 
removeAttribute(String) - Method in interface org.keycloak.models.ClientModel
 
removeAttribute(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
removeAttribute(String) - Method in interface org.keycloak.models.GroupModel
 
removeAttribute(String) - Method in interface org.keycloak.models.UserModel
 
removeAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
removeAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
removeAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
removeChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
Automatically calls setParent() on the subGroup
removeClient(String) - Method in interface org.keycloak.models.RealmModel
 
removeClient(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
 
removeClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeClientSession(String, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
removeClientSession(String, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
removeClientSession(RealmModel, ClientSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeClientTemplate(String) - Method in interface org.keycloak.models.RealmModel
 
removeCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
 
removeDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
removeDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
 
removeDetail(String) - Method in class org.keycloak.events.EventBuilder
 
removeExpired(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeFederatedIdentity(RealmModel, UserModel, String) - Method in class org.keycloak.models.UserFederationManager
 
removeFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider
 
removeGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
 
removeGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
 
removeIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
 
removeIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
removeNote(String) - Method in interface org.keycloak.models.ClientSessionModel
 
removeNote(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeNote(String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
removeNote(String) - Method in interface org.keycloak.models.UserSessionModel
 
removeOfflineClientSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeOfflineUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
removeRealm(String) - Method in interface org.keycloak.models.RealmProvider
 
removeRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
 
removeRequiredAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.ClientSessionModel
 
removeRequiredAction(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
removeRequiredAction(String) - Method in interface org.keycloak.models.UserModel
 
removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
 
removeRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
 
removeRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
removeResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
removeRole(RealmModel, RoleModel) - Method in interface org.keycloak.models.RealmProvider
 
removeRole(RoleModel) - Method in interface org.keycloak.models.RoleContainerModel
 
removeRoleById(String) - Method in interface org.keycloak.models.RealmModel
 
removeScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
removeUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
removeUser(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
 
removeUser(RealmModel, UserModel) - Method in interface org.keycloak.models.UserProvider
 
removeUser(RealmModel, UserModel) - Method in class org.keycloak.services.managers.UserManager
 
removeUser(RealmModel, UserModel, UserProvider) - Method in class org.keycloak.services.managers.UserManager
 
removeUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
removeUserFederationProvider(UserFederationProviderModel) - Method in interface org.keycloak.models.RealmModel
 
removeUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSession(String, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
removeUserSession(String, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
removeUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeUserSessions(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
 
removeWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
 
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.
RequiredActionProviderEntity - Class in org.keycloak.models.entities
 
RequiredActionProviderEntity() - Constructor for class org.keycloak.models.entities.RequiredActionProviderEntity
 
RequiredActionProviderModel - Class in org.keycloak.models
 
RequiredActionProviderModel() - Constructor for class org.keycloak.models.RequiredActionProviderModel
 
RequiredActionSpi - Class in org.keycloak.authentication
 
RequiredActionSpi() - Constructor for class org.keycloak.authentication.RequiredActionSpi
 
RequiredCredentialEntity - Class in org.keycloak.models.entities
 
RequiredCredentialEntity() - Constructor for class org.keycloak.models.entities.RequiredCredentialEntity
 
RequiredCredentialModel - Class in org.keycloak.models
 
RequiredCredentialModel() - Constructor for class org.keycloak.models.RequiredCredentialModel
 
requirement - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
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
 
resolveLocale(UserModel) - Method in interface org.keycloak.models.KeycloakContext
 
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.
ResourceServer.PolicyEnforcementMode - Enum in org.keycloak.authorization.model
The policy enforcement mode dictates how authorization requests are handled by the server.
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.
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.
retrieveToken - Variable in class org.keycloak.models.entities.ClientIdentityProviderMappingEntity
 
revokeConsentForClient(String) - Method in interface org.keycloak.models.UserModel
 
revokeConsentForClient(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
REVOKED_CLIENT - Static variable in interface org.keycloak.events.Details
 
ROLE - Static variable in interface org.keycloak.broker.provider.ConfigConstants
 
ROLE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
RoleContainerModel - Interface in org.keycloak.models
 
RoleContainerModel.RoleRemovedEvent - Interface in org.keycloak.models
 
RoleEntity - Class in org.keycloak.models.entities
 
RoleEntity() - Constructor for class org.keycloak.models.entities.RoleEntity
 
RoleMapperModel - Interface in org.keycloak.models
 
RoleModel - Interface in org.keycloak.models
 
rollback() - Method in interface org.keycloak.models.KeycloakTransaction
 
rootUrl - Variable in class org.keycloak.models.entities.ClientEntity
 
run(ClusterEvent) - Method in interface org.keycloak.cluster.ClusterListener
Registered task to be executed on all cluster nodes once it's notified from cache.
run(KeycloakSession) - Method in interface org.keycloak.models.KeycloakSessionTask
 
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

salt - Variable in class org.keycloak.models.entities.CredentialEntity
 
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.
ScopeContainerModel - Interface in org.keycloak.models
 
scopeIds - Variable in class org.keycloak.models.entities.ClientEntity
 
scopeIds - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
ScopeStore - Interface in org.keycloak.authorization.store
A ScopeStore is responsible to manage the persistence of Scope instances.
Script - Class in org.keycloak.scripting
 
Script(String, String, String, String, String, String) - Constructor for class org.keycloak.scripting.Script
 
SCRIPT_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
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, ScriptException) - Constructor for exception org.keycloak.scripting.ScriptExecutionException
 
scripting() - Method in interface org.keycloak.models.KeycloakSession
Keycloak scripting support.
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
 
ScriptModel - Interface in org.keycloak.models
Denotes an executable Script with metadata.
SEARCH_SCOPE - Static variable in class org.keycloak.models.LDAPConstants
 
searchByAttributes(Map<String, String>, RealmModel, int) - Method in interface org.keycloak.models.UserFederationProvider
Keycloak does not search in local storage first before calling this method.
searchFor(RoleModel, RoleModel, Set<RoleModel>) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Deep search if given role is descendant of composite role
searchForUser(String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(String, RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
searchForUser(String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
searchForUser(String, RealmModel, int, int) - Method in interface org.keycloak.models.UserProvider
 
searchForUserByAttributes(Map<String, String>, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUserByAttributes(Map<String, String>, RealmModel, int, int) - Method in class org.keycloak.models.UserFederationManager
 
searchForUserByAttributes(Map<String, String>, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
searchForUserByAttributes(Map<String, String>, RealmModel, int, int) - Method in interface org.keycloak.models.UserProvider
 
searchForUserByUserAttribute(String, String, RealmModel) - Method in class org.keycloak.models.UserFederationManager
 
searchForUserByUserAttribute(String, String, RealmModel) - Method in interface org.keycloak.models.UserProvider
 
secret - Variable in class org.keycloak.models.entities.ClientEntity
 
secret - Variable in class org.keycloak.models.RequiredCredentialModel
 
SECRET - Static variable in class org.keycloak.models.RequiredCredentialModel
 
SECRET - Static variable in class org.keycloak.models.UserCredentialModel
 
secret(String) - Static method in class org.keycloak.models.UserCredentialModel
 
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.
serviceAccountsEnabled - Variable in class org.keycloak.models.entities.ClientEntity
 
serviceAccountsEnabled - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
session(UserSessionModel) - Method in class org.keycloak.events.EventBuilder
 
session(String) - Method in class org.keycloak.events.EventBuilder
 
session - Variable in class org.keycloak.models.UserFederationManager
 
sessions() - Method in interface org.keycloak.models.KeycloakSession
Returns a managed provider instance.
setAccessCodeLifespan(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccessCodeLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessCodeLifespanLogin(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccessCodeLifespanLogin(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessCodeLifespanUserAction(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccessCodeLifespanUserAction(int) - Method in interface org.keycloak.models.RealmModel
 
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
 
setAccessTokenLifespan(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccessTokenLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setAccessTokenLifespanForImplicitFlow(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccessTokenLifespanForImplicitFlow(int) - Method in interface org.keycloak.models.RealmModel
 
setAccountTheme(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setAccountTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setAction(String) - Method in interface org.keycloak.models.ClientSessionModel
 
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
 
setAdded(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setAddReadTokenRoleOnCreate(boolean) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setAddReadTokenRoleOnCreate(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setAdminEventsDetailsEnabled(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setAdminEventsDetailsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setAdminEventsEnabled(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setAdminEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setAdminTheme(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setAdminTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setAlgorithm(String) - Method in class org.keycloak.models.entities.CredentialEntity
 
setAlgorithm(String) - Method in class org.keycloak.models.OTPPolicy
 
setAlgorithm(String) - Method in class org.keycloak.models.UserCredentialModel
 
setAlgorithm(String) - Method in class org.keycloak.models.UserCredentialValueModel
 
setAlias(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setAlias(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setAlias(String) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setAlias(String) - Method in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
setAlias(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setAlias(String) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setAlias(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setAlias(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
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, String) - Method in interface org.keycloak.models.ClientModel
 
setAttribute(String, String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setAttribute(String, List<String>) - Method in interface org.keycloak.models.GroupModel
 
setAttribute(String, List<String>) - Method in interface org.keycloak.models.UserModel
 
setAttribute(String, List<String>) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setAttributes(Map<String, String>) - Method in class org.keycloak.models.entities.ClientEntity
 
setAttributes(Map<String, String>) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setAttributes(Map<String, List<String>>) - Method in class org.keycloak.models.entities.GroupEntity
 
setAttributes(Map<String, List<String>>) - Method in class org.keycloak.models.entities.UserEntity
 
setAuthDetails(AuthDetails) - Method in class org.keycloak.events.admin.AdminEvent
 
setAuthenticateByDefault(boolean) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setAuthenticateByDefault(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setAuthenticatedUser(UserModel) - Method in interface org.keycloak.models.ClientSessionModel
 
setAuthenticatedUser(UserModel) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setAuthenticationFlows(List<AuthenticationFlowEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setAuthenticator(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthenticator(String) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setAuthenticatorConfig(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthenticatorConfig(String) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setAuthenticatorConfigs(List<AuthenticatorConfigEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setAuthenticatorFlow(boolean) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setAuthenticatorFlow(boolean) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setAuthMethod(String) - Method in interface org.keycloak.models.ClientSessionModel
 
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
 
setBaseUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setBaseUrl(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setBearerOnly(boolean) - Method in interface org.keycloak.models.ClientModel
 
setBearerOnly(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setBearerOnly(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setBearerOnly(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
setBrowserFlow(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setBrowserFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setBrowserSecurityHeaders(Map<String, String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setBrowserSecurityHeaders(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
 
setBruteForceProtected(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setBruteForceProtected(boolean) - Method in interface org.keycloak.models.RealmModel
 
setBuiltIn(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setBuiltIn(boolean) - Method in class org.keycloak.models.ClaimTypeModel
 
setBuiltIn(boolean) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setCalendar(Calendar) - Method in class org.keycloak.models.utils.TimeBasedOTP
 
setCertificate(X509Certificate) - Method in interface org.keycloak.models.RealmModel
 
setCertificatePem(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setCertificatePem(String) - Method in interface org.keycloak.models.RealmModel
 
setChangedSyncPeriod(int) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setChangedSyncPeriod(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setClient(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Attach a specific client to this flow.
setClient(ClientModel) - Method in interface org.keycloak.models.KeycloakContext
 
setClientAuthenticationFlow(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setClientAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setClientAuthenticatorType(String) - Method in interface org.keycloak.models.ClientModel
 
setClientAuthenticatorType(String) - Method in class org.keycloak.models.entities.ClientEntity
 
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 interface org.keycloak.models.ClientModel
 
setClientId(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setClientId(String) - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
setClientId(String) - Method in class org.keycloak.models.entities.RoleEntity
 
setClientId(String) - Method in class org.keycloak.models.entities.UserConsentEntity
 
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.entities.PersistentClientSessionEntity
 
setClientSessionId(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setClientSessions(List<PersistentClientSessionEntity>) - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
setClientTemplate(ClientTemplateModel) - Method in interface org.keycloak.models.ClientModel
 
setClientTemplate(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setCode(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCode(String) - Method in class org.keycloak.scripting.Script
 
setCodeSecret(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setCodeSecret(String) - Method in interface org.keycloak.models.RealmModel
 
setCompositeRoleIds(List<String>) - Method in class org.keycloak.models.entities.RoleEntity
 
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.
setConfig(Map<String, String>) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.AuthenticatorConfigEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.ProtocolMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.UserFederationMapperModel
 
setConfig(Map<String, String>) - Method in class org.keycloak.models.UserFederationProviderModel
 
setConnection(ClientConnection) - Method in interface org.keycloak.models.KeycloakContext
 
setConsentRequired(boolean) - Method in interface org.keycloak.models.ClientModel
 
setConsentRequired(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setConsentRequired(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setConsentRequired(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setConsentRequired(boolean) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setConsentRequired(boolean) - Method in class org.keycloak.models.ProtocolMapperModel
 
setConsentText(String) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setConsentText(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setContextData(Map<String, Object>) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCounter(int) - Method in class org.keycloak.models.entities.CredentialEntity
 
setCounter(int) - Method in class org.keycloak.models.UserCredentialValueModel
 
setCreatedDate(Long) - Method in class org.keycloak.models.entities.CredentialEntity
 
setCreatedDate(Long) - Method in class org.keycloak.models.UserCredentialValueModel
 
setCreatedTimestamp(Long) - Method in class org.keycloak.models.entities.UserEntity
 
setCreatedTimestamp(Long) - Method in interface org.keycloak.models.UserModel
 
setCreatedTimestamp(Long) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setCredentials(List<CredentialEntity>) - Method in class org.keycloak.models.entities.UserEntity
 
setData(String) - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
setData(String) - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
setData(String) - Method in class org.keycloak.models.session.PersistentClientSessionModel
 
setData(String) - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
setDecisionStrategy(Policy.DecisionStrategy) - Method in interface org.keycloak.authorization.model.Policy
Sets the {DecisionStrategy} for this policy.
setDefaultAction(boolean) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setDefaultAction(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setDefaultGroups(List<String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setDefaultLocale(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setDefaultLocale(String) - Method in interface org.keycloak.models.RealmModel
 
setDefaultRoles(List<String>) - Method in class org.keycloak.models.entities.ClientEntity
 
setDefaultRoles(List<String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setDefaultValue(Object) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setDescription(String) - Method in interface org.keycloak.authorization.model.Policy
Sets the description for this policy.
setDescription(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setDescription(String) - Method in interface org.keycloak.models.ClientModel
 
setDescription(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setDescription(String) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setDescription(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setDescription(String) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setDescription(String) - Method in class org.keycloak.models.entities.RoleEntity
 
setDescription(String) - Method in interface org.keycloak.models.RoleModel
 
setDescription(String) - Method in class org.keycloak.scripting.Script
 
setDetails(Map<String, String>) - Method in class org.keycloak.events.Event
 
setDevice(String) - Method in class org.keycloak.models.entities.CredentialEntity
 
setDevice(String) - Method in class org.keycloak.models.UserCredentialModel
 
setDevice(String) - Method in class org.keycloak.models.UserCredentialValueModel
 
setDigits(int) - Method in class org.keycloak.models.entities.CredentialEntity
 
setDigits(int) - Method in class org.keycloak.models.OTPPolicy
 
setDigits(int) - Method in class org.keycloak.models.UserCredentialValueModel
 
setDirectAccessGrantsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setDirectAccessGrantsEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setDirectAccessGrantsEnabled(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setDirectAccessGrantsEnabled(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setDirectGrantFlow(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setDirectGrantFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setDisplayName(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setDisplayName(String) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setDisplayName(String) - Method in interface org.keycloak.models.RealmModel
 
setDisplayName(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setDisplayNameHtml(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setDisplayNameHtml(String) - Method in interface org.keycloak.models.RealmModel
 
setEditUsernameAllowed(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setEditUsernameAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEmail(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setEmail(String) - Method in class org.keycloak.models.entities.UserEntity
 
setEmail(String) - Method in interface org.keycloak.models.UserModel
 
setEmail(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setEmailTheme(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setEmailTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setEmailVerified(boolean) - Method in class org.keycloak.models.entities.UserEntity
 
setEmailVerified(boolean) - Method in interface org.keycloak.models.UserModel
 
setEmailVerified(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setEnabled(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setEnabled(boolean) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setEnabled(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setEnabled(boolean) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setEnabled(boolean) - Method in class org.keycloak.models.entities.UserEntity
 
setEnabled(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEnabled(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setEnabled(boolean) - Method in interface org.keycloak.models.UserModel
 
setEnabled(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setEnabledEventTypes(List<String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setEnabledEventTypes(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
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
 
setEventsEnabled(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
setEventsExpiration(long) - Method in class org.keycloak.models.entities.RealmEntity
 
setEventsExpiration(long) - Method in interface org.keycloak.models.RealmModel
 
setEventsListeners(List<String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setEventsListeners(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
setExecutions(List<AuthenticationExecutionEntity>) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setExecutionStatus(String, ClientSessionModel.ExecutionStatus) - Method in interface org.keycloak.models.ClientSessionModel
 
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
 
setFailed(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setFailedLoginNotBefore(int) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setFailedLoginNotBefore(int) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setFailureFactor(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setFailureFactor(int) - Method in interface org.keycloak.models.RealmModel
 
setFeatures(boolean, boolean, boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setFederatedIdentities(List<FederatedIdentityEntity>) - Method in class org.keycloak.models.entities.UserEntity
 
setFederationLink(String) - Method in class org.keycloak.models.entities.UserEntity
 
setFederationLink(String) - Method in interface org.keycloak.models.UserModel
 
setFederationLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setFederationMapperType(String) - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
setFederationMapperType(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setFederationProviderId(String) - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
setFederationProviderId(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setFirstBrokerLoginFlowId(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setFirstBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setFirstName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setFirstName(String) - Method in class org.keycloak.models.entities.UserEntity
 
setFirstName(String) - Method in interface org.keycloak.models.UserModel
 
setFirstName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setFlowId(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setFlowId(String) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setFormLabel(String) - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
setFormLabel(String) - Method in class org.keycloak.models.RequiredCredentialModel
 
setFrontchannelLogout(boolean) - Method in interface org.keycloak.models.ClientModel
 
setFrontchannelLogout(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setFrontchannelLogout(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setFrontchannelLogout(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setFullScopeAllowed(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setFullScopeAllowed(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setFullScopeAllowed(boolean) - Method in interface org.keycloak.models.ScopeContainerModel
 
setFullSyncPeriod(int) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setFullSyncPeriod(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setGrantedProtocolMappers(List<String>) - Method in class org.keycloak.models.entities.UserConsentEntity
 
setGrantedRoles(List<String>) - Method in class org.keycloak.models.entities.UserConsentEntity
 
setGroupIds(List<String>) - Method in class org.keycloak.models.entities.UserEntity
 
setHashIterations(int) - Method in class org.keycloak.models.entities.CredentialEntity
 
setHashIterations(int) - Method in class org.keycloak.models.UserCredentialValueModel
 
setHelpText(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
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.models.AuthenticationExecutionModel
 
setId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setId(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
 
setId(String) - Method in class org.keycloak.models.ClaimTypeModel
 
setId(String) - Method in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
setId(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setId(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setId(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setId(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setId(String) - Method in class org.keycloak.scripting.Script
 
setIdentityProvider(String) - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
setIdentityProviderAlias(String) - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
setIdentityProviderAlias(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setIdentityProviderMapper(String) - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
setIdentityProviderMapper(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setIdentityProviderMappers(List<IdentityProviderMapperEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setIdentityProviders(List<ClientIdentityProviderMappingEntity>) - Method in class org.keycloak.models.entities.ClientEntity
 
setIdentityProviders(List<IdentityProviderEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setIdp(IdentityProvider) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setIdpConfig(IdentityProviderModel) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setIgnored(boolean) - Method in class org.keycloak.models.UserFederationSyncResult
 
setImplicitFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setImplicitFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setImplicitFlowEnabled(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setImplicitFlowEnabled(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setInfo(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setInitialCounter(int) - Method in class org.keycloak.models.OTPPolicy
 
setInput(boolean) - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
setInput(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
 
setInternalId(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setInternalId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setInternationalizationEnabled(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setInternationalizationEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
 
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
 
setLabel(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setLastFailure(long) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setLastFailure(long) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setLastIPFailure(String) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setLastIPFailure(String) - Method in interface org.keycloak.models.UserLoginFailureModel
 
setLastName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setLastName(String) - Method in class org.keycloak.models.entities.UserEntity
 
setLastName(String) - Method in interface org.keycloak.models.UserModel
 
setLastName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setLastSessionRefresh(int) - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
setLastSessionRefresh(int) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
setLastSessionRefresh(int) - Method in class org.keycloak.models.session.PersistentUserSessionModel
 
setLastSessionRefresh(int) - Method in interface org.keycloak.models.UserSessionModel
 
setLastSync(int) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setLastSync(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setLogic(Policy.Logic) - Method in interface org.keycloak.authorization.model.Policy
Sets the {Logic} for this policy.
setLoginTheme(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setLoginTheme(String) - Method in interface org.keycloak.models.RealmModel
 
setLookAheadWindow(int) - Method in class org.keycloak.models.OTPPolicy
 
setManagementUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setManagementUrl(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setMasterAdminClient(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setMasterAdminClient(ClientModel) - Method in interface org.keycloak.models.RealmModel
 
setMaxDeltaTimeSeconds(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setMaxDeltaTimeSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setMaxFailureWaitSeconds(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setMaxFailureWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setMimeType(String) - Method in class org.keycloak.scripting.Script
 
setMinimumQuickLoginWaitSeconds(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setMinimumQuickLoginWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
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.models.ClaimTypeModel
 
setName(String) - Method in interface org.keycloak.models.ClientModel
 
setName(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setName(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setName(String) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setName(String) - Method in class org.keycloak.models.entities.GroupEntity
 
setName(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setName(String) - Method in class org.keycloak.models.entities.IdentityProviderMapperEntity
 
setName(String) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setName(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setName(String) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setName(String) - Method in class org.keycloak.models.entities.RoleEntity
 
setName(String) - Method in class org.keycloak.models.entities.UserFederationMapperEntity
 
setName(String) - Method in interface org.keycloak.models.GroupModel
 
setName(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
 
setName(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setName(String) - Method in interface org.keycloak.models.RealmModel
 
setName(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setName(String) - Method in interface org.keycloak.models.RoleModel
 
setName(String) - Method in class org.keycloak.models.UserFederationMapperModel
 
setName(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
setName(String) - Method in class org.keycloak.scripting.Script
 
setNodeReRegistrationTimeout(int) - Method in interface org.keycloak.models.ClientModel
 
setNodeReRegistrationTimeout(int) - Method in class org.keycloak.models.entities.ClientEntity
 
setNotBefore(int) - Method in interface org.keycloak.models.ClientModel
 
setNotBefore(int) - Method in class org.keycloak.models.entities.ClientEntity
 
setNotBefore(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setNotBefore(int) - Method in interface org.keycloak.models.RealmModel
 
setNote(String, String) - Method in interface org.keycloak.models.ClientSessionModel
 
setNote(String, String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setNote(String, String) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter
 
setNote(String, String) - Method in interface org.keycloak.models.UserSessionModel
 
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
 
setNumFailures(int) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setOfflineSessionIdleTimeout(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setOfflineSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
 
setOperationType(OperationType) - Method in class org.keycloak.events.admin.AdminEvent
 
setOtpEnabled(boolean) - Method in interface org.keycloak.models.UserModel
 
setOtpEnabled(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setOTPPolicy(OTPPolicy) - Method in interface org.keycloak.models.RealmModel
 
setOtpPolicyAlgorithm(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setOtpPolicyDigits(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setOtpPolicyInitialCounter(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setOtpPolicyLookAheadWindow(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setOtpPolicyPeriod(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setOtpPolicyType(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setParameters(Object[]) - Method in exception org.keycloak.mappers.FederationConfigValidationException
 
setParameters(Object[]) - Method in exception org.keycloak.models.ModelException
 
setParent(GroupModel) - Method in interface org.keycloak.models.GroupModel
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group
setParentFlow(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setParentFlow(String) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setParentId(String) - Method in class org.keycloak.models.entities.GroupEntity
 
setPasswordPolicy(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setPasswordPolicy(PasswordPolicy) - Method in interface org.keycloak.models.RealmModel
 
setPasswordSet(boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setPeriod(int) - Method in class org.keycloak.models.entities.CredentialEntity
 
setPeriod(int) - Method in class org.keycloak.models.OTPPolicy
 
setPeriod(int) - Method in class org.keycloak.models.UserCredentialValueModel
 
setPolicyEnforcementMode(ResourceServer.PolicyEnforcementMode) - Method in interface org.keycloak.authorization.model.ResourceServer
Defines a PolicyEnforcementMode for this instance.
setPostBrokerLoginFlowId(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setPostBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setPriority(int) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setPriority(int) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setPriority(int) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setPriority(int) - Method in class org.keycloak.models.UserFederationProviderModel
 
setPrivateKey(PrivateKey) - Method in interface org.keycloak.models.RealmModel
 
setPrivateKeyPem(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setPrivateKeyPem(String) - Method in interface org.keycloak.models.RealmModel
 
setProfileFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setProtocol(String) - Method in interface org.keycloak.models.ClientModel
 
setProtocol(String) - Method in interface org.keycloak.models.ClientTemplateModel
 
setProtocol(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setProtocol(String) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setProtocol(String) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setProtocol(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setProtocolMapper(String) - Method in class org.keycloak.models.entities.ProtocolMapperEntity
 
setProtocolMapper(String) - Method in class org.keycloak.models.ProtocolMapperModel
 
setProtocolMappers(Set<String>) - Method in interface org.keycloak.models.ClientSessionModel
 
setProtocolMappers(List<ProtocolMapperEntity>) - Method in class org.keycloak.models.entities.ClientEntity
 
setProtocolMappers(List<ProtocolMapperEntity>) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setProtocolMappers(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setProtocolMappers(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setProviderId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setProviderId(String) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setProviderId(String) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setProviderId(String) - Method in class org.keycloak.models.entities.RequiredActionProviderEntity
 
setProviderId(String) - Method in class org.keycloak.models.IdentityProviderModel
 
setProviderId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
 
setProviderName(String) - Method in class org.keycloak.models.entities.UserFederationProviderEntity
 
setProviderName(String) - Method in class org.keycloak.models.UserFederationProviderModel
 
setPublicClient(boolean) - Method in interface org.keycloak.models.ClientModel
 
setPublicClient(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setPublicClient(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setPublicClient(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setPublicKey(PublicKey) - Method in interface org.keycloak.models.RealmModel
 
setPublicKeyPem(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setPublicKeyPem(String) - Method in interface org.keycloak.models.RealmModel
 
setQuickLoginCheckMilliSeconds(long) - Method in class org.keycloak.models.entities.RealmEntity
 
setQuickLoginCheckMilliSeconds(long) - Method in interface org.keycloak.models.RealmModel
 
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.models.KeycloakContext
 
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.models.entities.ClientEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.GroupEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.RoleEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.UserEntity
 
setRealmId(String) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setRealmId(String) - Method in class org.keycloak.scripting.Script
 
setRedirectUri(String) - Method in interface org.keycloak.models.ClientSessionModel
 
setRedirectUri(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setRedirectUri(String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setRedirectUris(Set<String>) - Method in interface org.keycloak.models.ClientModel
 
setRedirectUris(List<String>) - Method in class org.keycloak.models.entities.ClientEntity
 
setReferrer(String[]) - Method in interface org.keycloak.forms.account.AccountProvider
 
setRegisteredNodes(Map<String, Integer>) - Method in class org.keycloak.models.entities.ClientEntity
 
setRegistrationAllowed(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setRegistrationAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationEmailAsUsername(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setRegistrationEmailAsUsername(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationFlow(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setRegistrationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setRegistrationToken(String) - Method in interface org.keycloak.models.ClientModel
 
setRegistrationToken(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setRememberMe(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setRememberMe(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRememberMe(boolean) - Method in class org.keycloak.models.session.PersistentUserSessionAdapter.PersistentUserSessionData
 
setRemoved(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
setRepresentation(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setRequiredActionProviders(List<RequiredActionProviderEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
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(List<String>) - Method in class org.keycloak.models.entities.UserEntity
 
setRequiredActions(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setRequiredCredentials(List<RequiredCredentialEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setRequirement(AuthenticationExecutionModel.Requirement) - Method in class org.keycloak.models.AuthenticationExecutionModel
 
setRequirement(AuthenticationExecutionModel.Requirement) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setResetCredentialsFlow(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setResetCredentialsFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
setResetPasswordAllowed(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setResetPasswordAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
 
setResourcePath(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setResponseHeader(String, String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setRetrieveToken(boolean) - Method in class org.keycloak.models.entities.ClientIdentityProviderMappingEntity
 
setRevokeRefreshToken(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setRevokeRefreshToken(boolean) - Method in interface org.keycloak.models.RealmModel
 
setRoleIds(List<String>) - Method in class org.keycloak.models.entities.GroupEntity
 
setRoleIds(List<String>) - Method in class org.keycloak.models.entities.UserEntity
 
setRoles(Set<String>) - Method in interface org.keycloak.models.ClientSessionModel
 
setRoles(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setRoles(Set<String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
 
setRootUrl(String) - Method in interface org.keycloak.models.ClientModel
 
setRootUrl(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setSalt(byte[]) - Method in class org.keycloak.models.entities.CredentialEntity
 
setSalt(byte[]) - Method in class org.keycloak.models.UserCredentialValueModel
 
setScopeIds(List<String>) - Method in class org.keycloak.models.entities.ClientEntity
 
setScopeIds(List<String>) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
setScopeParamRequired(boolean) - Method in class org.keycloak.models.entities.RoleEntity
 
setScopeParamRequired(boolean) - Method in interface org.keycloak.models.RoleModel
 
setSecret(String) - Method in interface org.keycloak.models.ClientModel
 
setSecret(String) - Method in class org.keycloak.models.entities.ClientEntity
 
setSecret(boolean) - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
setSecret(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
 
setServiceAccountClientLink(String) - Method in class org.keycloak.models.entities.UserEntity
 
setServiceAccountClientLink(String) - Method in interface org.keycloak.models.UserModel
 
setServiceAccountClientLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setServiceAccountsEnabled(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setServiceAccountsEnabled(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
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 interface org.keycloak.models.GroupModel
Set single value of specified attribute.
setSingleAttribute(String, String) - Method in interface org.keycloak.models.UserModel
Set single value of specified attribute.
setSingleAttribute(String, String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setSmtpConfig(Map<String, String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setSmtpConfig(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
 
setSocialConfig(Map<String, String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setSslRequired(String) - Method in class org.keycloak.models.entities.RealmEntity
 
setSslRequired(SslRequired) - Method in interface org.keycloak.models.RealmModel
 
setSsoSessionIdleTimeout(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setSsoSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
 
setSsoSessionMaxLifespan(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setSsoSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
 
setStandardFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
 
setStandardFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientTemplateModel
 
setStandardFlowEnabled(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setStandardFlowEnabled(boolean) - Method in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
setState(UserSessionModel.State) - Method in interface org.keycloak.models.UserSessionModel
 
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
 
setStoredVersion(String) - Method in interface org.keycloak.migration.MigrationModel
 
setStoreToken(boolean) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setStoreToken(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setSupportedLocales(List<String>) - Method in class org.keycloak.models.entities.RealmEntity
 
setSupportedLocales(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
setSurrogateAuthRequired(boolean) - Method in interface org.keycloak.models.ClientModel
 
setSurrogateAuthRequired(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
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 interface org.keycloak.models.ClientSessionModel
 
setTimestamp(int) - Method in class org.keycloak.models.entities.PersistentClientSessionEntity
 
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
 
setToken(String) - Method in class org.keycloak.models.entities.FederatedIdentityEntity
 
setToken(String) - Method in class org.keycloak.models.FederatedIdentityModel
 
setTopLevel(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
 
setTopLevel(boolean) - Method in class org.keycloak.models.entities.AuthenticationFlowEntity
 
setTotp(boolean) - Method in class org.keycloak.models.entities.UserEntity
 
setTrustEmail(boolean) - Method in class org.keycloak.models.entities.IdentityProviderEntity
 
setTrustEmail(boolean) - Method in class org.keycloak.models.IdentityProviderModel
 
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
 
setType(ClaimTypeModel.ValueType) - Method in class org.keycloak.models.ClaimTypeModel
 
setType(String) - Method in class org.keycloak.models.entities.CredentialEntity
 
setType(String) - Method in class org.keycloak.models.entities.RequiredCredentialEntity
 
setType(String) - Method in class org.keycloak.models.OTPPolicy
 
setType(String) - Method in class org.keycloak.models.RequiredCredentialModel
 
setType(String) - Method in class org.keycloak.models.UserCredentialModel
 
setType(String) - Method in class org.keycloak.models.UserCredentialValueModel
 
setType(String) - Method in class org.keycloak.provider.ProviderConfigProperty
 
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.MigrationTo1_2_0_CR1
 
setupClientDefaults(ClientRepresentation, ClientModel) - Method in interface org.keycloak.protocol.LoginProtocolFactory
Setup default values for new clients.
setUpdated(int) - Method in class org.keycloak.models.UserFederationSyncResult
 
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
 
setUser(UserEntity) - Method in class org.keycloak.models.entities.CredentialEntity
 
setUserAttribute(String, String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUserFederationMappers(List<UserFederationMapperEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setUserFederationProviders(List<UserFederationProviderEntity>) - Method in class org.keycloak.models.entities.RealmEntity
 
setUserFederationProviders(List<UserFederationProviderModel>) - Method in interface org.keycloak.models.RealmModel
 
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.entities.FederatedIdentityEntity
 
setUserId(String) - Method in class org.keycloak.models.entities.PersistentUserSessionEntity
 
setUserId(String) - Method in class org.keycloak.models.entities.UserConsentEntity
 
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.entities.FederatedIdentityEntity
 
setUsername(String) - Method in class org.keycloak.models.entities.UserEntity
 
setUsername(String) - Method in class org.keycloak.models.entities.UsernameLoginFailureEntity
 
setUsername(String) - Method in interface org.keycloak.models.UserModel
 
setUsername(String) - Method in class org.keycloak.models.utils.UserModelDelegate
 
setUserSession(UserSessionModel) - Method in interface org.keycloak.models.ClientSessionModel
 
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 interface org.keycloak.models.ClientSessionModel
These are notes you want applied to the UserSessionModel when the client session is attached to it.
setUserSessionNote(String, String) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter
 
setUserSessionNotes(Map<String, String>) - Method in class org.keycloak.models.session.PersistentClientSessionAdapter.PersistentClientSessionData
 
setUserSetupAllowed(boolean) - Method in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
setUseTemplateConfig(boolean) - Method in interface org.keycloak.models.ClientModel
 
setUseTemplateConfig(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setUseTemplateMappers(boolean) - Method in interface org.keycloak.models.ClientModel
 
setUseTemplateMappers(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setUseTemplateScope(boolean) - Method in interface org.keycloak.models.ClientModel
 
setUseTemplateScope(boolean) - Method in class org.keycloak.models.entities.ClientEntity
 
setValue(String) - Method in class org.keycloak.models.entities.CredentialEntity
 
setValue(String) - Method in class org.keycloak.models.UserCredentialModel
 
setValue(String) - Method in class org.keycloak.models.UserCredentialValueModel
 
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.
setVerifyEmail(boolean) - Method in class org.keycloak.models.entities.RealmEntity
 
setVerifyEmail(boolean) - Method in interface org.keycloak.models.RealmModel
 
setWaitIncrementSeconds(int) - Method in class org.keycloak.models.entities.RealmEntity
 
setWaitIncrementSeconds(int) - Method in interface org.keycloak.models.RealmModel
 
setWarning(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setWebOrigins(Set<String>) - Method in interface org.keycloak.models.ClientModel
 
setWebOrigins(List<String>) - Method in class org.keycloak.models.entities.ClientEntity
 
SHAPasswordEncoder - Class in org.keycloak.models.utils
Password that uses SHA to encode passwords.
SHAPasswordEncoder(int) - Constructor for class org.keycloak.models.utils.SHAPasswordEncoder
 
SimpleHttp - Class in org.keycloak.broker.provider.util
 
SimpleHttp(String, String) - Constructor for class org.keycloak.broker.provider.util.SimpleHttp
 
SINGLETON - Static variable in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
 
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
 
Spi - Interface in org.keycloak.provider
 
SSL_REQUIRED - Static variable in interface org.keycloak.events.Errors
 
sslFactory(SSLSocketFactory) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
standardFlowEnabled - Variable in class org.keycloak.models.entities.ClientEntity
 
standardFlowEnabled - Variable in class org.keycloak.models.entities.ClientTemplateEntity
 
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
 
STRING_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
 
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
 
surrogateAuthRequired - Variable in class org.keycloak.models.entities.ClientEntity
 
SYNC_REGISTRATIONS - Static variable in class org.keycloak.models.LDAPConstants
 
syncAllUsers(KeycloakSessionFactory, String, UserFederationProviderModel) - Method in interface org.keycloak.models.UserFederationProviderFactory
Sync all users from the provider storage to Keycloak storage.
syncChangedUsers(KeycloakSessionFactory, String, UserFederationProviderModel, Date) - Method in interface org.keycloak.models.UserFederationProviderFactory
Sync just changed (added / updated / removed) users from the provider storage to Keycloak storage.
syncDataFromFederationProviderToKeycloak(UserFederationMapperModel, UserFederationProvider, KeycloakSession, RealmModel) - Method in interface org.keycloak.mappers.UserFederationMapper
Sync data from federation storage to Keycloak.
syncDataFromKeycloakToFederationProvider(UserFederationMapperModel, UserFederationProvider, KeycloakSession, RealmModel) - Method in interface org.keycloak.mappers.UserFederationMapper
Sync data from Keycloak back to federation 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
 
Synchronizer<E extends ProviderEvent> - Interface in org.keycloak.authorization.store.syncronization
 
synchronizeRegistrations() - Method in interface org.keycloak.models.UserFederationProvider
Should user registrations be synchronized with this provider? FYI, only one provider will be chosen (by priority) to have this synchronization

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(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
 
topLevel - Variable in class org.keycloak.models.entities.AuthenticationFlowEntity
 
toPolicy(RealmRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toRepresentation(GroupModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(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
 
toString() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
toString() - Method in class org.keycloak.models.entities.AbstractIdentifiableEntity
 
toString() - Method in class org.keycloak.models.PasswordPolicy
 
toString() - Method in class org.keycloak.models.UserFederationMapperModel
 
toString() - Method in class org.keycloak.models.UserFederationSyncResult
 
toString() - Method in class org.keycloak.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
TOTP - Static variable in class org.keycloak.models.RequiredCredentialModel
 
TOTP - Static variable in class org.keycloak.models.UserCredentialModel
 
totp(String) - Static method in class org.keycloak.models.UserCredentialModel
 
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
 
type - Variable in class org.keycloak.models.entities.CredentialEntity
 
type - Variable in class org.keycloak.models.OTPPolicy
 
type - Variable in class org.keycloak.models.RequiredCredentialModel
 
type - Variable in class org.keycloak.models.UserCredentialModel
 
type - Variable in class org.keycloak.provider.ProviderConfigProperty
 
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
 
unregister(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
 
unregisterNode(String) - Method in interface org.keycloak.models.ClientModel
 
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
 
updateAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
 
updateAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
 
updateAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
 
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() - Method in interface org.keycloak.models.ClientModel
 
updateClient(ClientRepresentation, ClientModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateClientTemplate(ClientTemplateRepresentation, ClientTemplateModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateConsent(UserConsentModel) - Method in interface org.keycloak.models.UserModel
 
updateConsent(UserConsentModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
updateCredential(RealmModel, UserModel, UserCredentialModel) - Method in class org.keycloak.models.UserFederationManager
 
updateCredential(UserCredentialModel) - Method in interface org.keycloak.models.UserModel
 
updateCredential(UserCredentialModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
updateCredentialDirectly(UserCredentialValueModel) - Method in interface org.keycloak.models.UserModel
 
updateCredentialDirectly(UserCredentialValueModel) - Method in class org.keycloak.models.utils.UserModelDelegate
 
UPDATED_EMAIL - Static variable in interface org.keycloak.events.Details
 
UPDATED_REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
updateDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
 
updateFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in class org.keycloak.models.UserFederationManager
 
updateFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
 
updateIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
 
updateIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
 
updateProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
 
updateRealm(RealmRepresentation, RealmModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
 
updateRequiredCredentials(Set<String>) - Method in interface org.keycloak.models.RealmModel
 
updateScopes(Set<Scope>) - Method in interface org.keycloak.authorization.model.Resource
 
updateUserFederationMapper(UserFederationMapperModel) - Method in interface org.keycloak.models.RealmModel
 
updateUserFederationProvider(UserFederationProviderModel) - Method in interface org.keycloak.models.RealmModel
 
updateUserSession(UserSessionModel, boolean) - Method in class org.keycloak.models.session.DisabledUserSessionPersisterProvider
 
updateUserSession(UserSessionModel, boolean) - Method in interface org.keycloak.models.session.UserSessionPersisterProvider
 
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 - Variable in class org.keycloak.models.entities.CredentialEntity
 
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
 
UserConsentEntity - Class in org.keycloak.models.entities
 
UserConsentEntity() - Constructor for class org.keycloak.models.entities.UserConsentEntity
 
UserConsentModel - Class in org.keycloak.models
 
UserConsentModel(ClientModel) - Constructor for class org.keycloak.models.UserConsentModel
 
UserCredentialModel - Class in org.keycloak.models
 
UserCredentialModel() - Constructor for class org.keycloak.models.UserCredentialModel
 
UserCredentialValueModel - Class in org.keycloak.models
Used just in cases when we want to "directly" update or retrieve the hash or salt of user credential (For example during export/import)
UserCredentialValueModel() - Constructor for class org.keycloak.models.UserCredentialValueModel
 
UserEntity - Class in org.keycloak.models.entities
 
UserEntity() - Constructor for class org.keycloak.models.entities.UserEntity
 
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
 
UserFederationManager - Class in org.keycloak.models
 
UserFederationManager(KeycloakSession) - Constructor for class org.keycloak.models.UserFederationManager
 
UserFederationMapper - Interface in org.keycloak.mappers
 
UserFederationMapperEntity - Class in org.keycloak.models.entities
 
UserFederationMapperEntity() - Constructor for class org.keycloak.models.entities.UserFederationMapperEntity
 
UserFederationMapperFactory - Interface in org.keycloak.mappers
 
UserFederationMapperModel - Class in org.keycloak.models
 
UserFederationMapperModel() - Constructor for class org.keycloak.models.UserFederationMapperModel
 
UserFederationMapperSpi - Class in org.keycloak.mappers
 
UserFederationMapperSpi() - Constructor for class org.keycloak.mappers.UserFederationMapperSpi
 
UserFederationProvider - Interface in org.keycloak.models
SPI for plugging in federation storage.
UserFederationProvider.EditMode - Enum in org.keycloak.models
Optional type that can be by implementations to describe edit mode of federation storage
UserFederationProviderCreationEventImpl - Class in org.keycloak.models
 
UserFederationProviderCreationEventImpl(RealmModel, UserFederationProviderModel) - Constructor for class org.keycloak.models.UserFederationProviderCreationEventImpl
 
UserFederationProviderEntity - Class in org.keycloak.models.entities
 
UserFederationProviderEntity() - Constructor for class org.keycloak.models.entities.UserFederationProviderEntity
 
UserFederationProviderFactory - Interface in org.keycloak.models
 
UserFederationProviderModel - Class in org.keycloak.models
Stored configuration of a User Federation provider instance.
UserFederationProviderModel() - Constructor for class org.keycloak.models.UserFederationProviderModel
 
UserFederationProviderModel(String, String, Map<String, String>, int, String, int, int, int) - Constructor for class org.keycloak.models.UserFederationProviderModel
 
UserFederationSpi - Class in org.keycloak.models
 
UserFederationSpi() - Constructor for class org.keycloak.models.UserFederationSpi
 
UserFederationSyncResult - Class in org.keycloak.models
 
UserFederationSyncResult() - Constructor for class org.keycloak.models.UserFederationSyncResult
 
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
UserLoginFailureModel - Interface in org.keycloak.models
 
UserManager - Class in org.keycloak.services.managers
 
UserManager(KeycloakSession) - Constructor for class org.keycloak.services.managers.UserManager
 
UserModel - Interface in org.keycloak.models
 
UserModel.RequiredAction - Enum in org.keycloak.models
 
UserModel.UserRemovedEvent - Interface in org.keycloak.models
 
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 - Static variable in interface org.keycloak.models.UserFederationProvider
 
USERNAME - Static variable in interface org.keycloak.models.UserModel
 
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
 
UsernameLoginFailureEntity - Class in org.keycloak.models.entities
 
UsernameLoginFailureEntity() - Constructor for class org.keycloak.models.entities.UsernameLoginFailureEntity
 
UserProvider - Interface in org.keycloak.models
 
UserProviderFactory - Interface in org.keycloak.models
 
users() - Method in interface org.keycloak.models.KeycloakSession
Possibly both cached and federated view of users depending on configuration.
USERS_DN - Static variable in class org.keycloak.models.LDAPConstants
 
UserSessionModel - Interface in org.keycloak.models
 
UserSessionModel.State - Enum in org.keycloak.models
 
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
 
UserSessionProvider - Interface in org.keycloak.models
 
UserSessionProviderFactory - Interface in org.keycloak.models
 
UserSessionSpi - Class in org.keycloak.models
 
UserSessionSpi() - Constructor for class org.keycloak.models.UserSessionSpi
 
userSetupAllowed - Variable in class org.keycloak.models.entities.AuthenticationExecutionEntity
 
UsersExportStrategy - Enum in org.keycloak.exportimport
 
UserSpi - Class in org.keycloak.models
 
UserSpi() - Constructor for class org.keycloak.models.UserSpi
 
userStorage() - Method in interface org.keycloak.models.KeycloakSession
Keycloak user storage.
useTemplateConfig() - Method in interface org.keycloak.models.ClientModel
 
useTemplateConfig - Variable in class org.keycloak.models.entities.ClientEntity
 
useTemplateMappers() - Method in interface org.keycloak.models.ClientModel
 
useTemplateMappers - Variable in class org.keycloak.models.entities.ClientEntity
 
useTemplateScope() - Method in interface org.keycloak.models.ClientModel
 
useTemplateScope - Variable in class org.keycloak.models.entities.ClientEntity
 
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(KeycloakSession, UserModel, String) - Method in class org.keycloak.models.PasswordPolicy
 
validate(KeycloakSession, String, String) - Method in class org.keycloak.models.PasswordPolicy
 
VALIDATE_ACCESS_TOKEN - Static variable in interface org.keycloak.events.Details
 
validateAndProxy(RealmModel, UserModel) - Method in interface org.keycloak.models.UserFederationProvider
Gives the provider an option to validate if user still exists in federation backend and then proxy UserModel loaded from local storage.
validateAndProxyUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
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
validateHashedCredential(KeycloakSession, RealmModel, UserModel, String, UserCredentialValueModel) - Static method in class org.keycloak.models.utils.CredentialValidation
 
validateHOTP(String, String, int) - Method in class org.keycloak.models.utils.HmacOTP
 
validateSecret(String) - Method in interface org.keycloak.models.ClientModel
 
validateTOTP(String, byte[]) - Method in class org.keycloak.models.utils.TimeBasedOTP
Validates a token using a secret key.
validateUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserFederationManager
 
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
validCredentials(KeycloakSession, RealmModel, UserModel, List<UserCredentialModel>) - Method in class org.keycloak.models.UserFederationManager
 
validCredentials(KeycloakSession, RealmModel, UserModel, UserCredentialModel...) - Method in class org.keycloak.models.UserFederationManager
 
validCredentials(KeycloakSession, RealmModel, UserCredentialModel...) - Method in class org.keycloak.models.UserFederationManager
 
validCredentials(RealmModel, UserModel, List<UserCredentialModel>) - Method in interface org.keycloak.models.UserFederationProvider
Validate credentials for this user.
validCredentials(RealmModel, UserModel, UserCredentialModel...) - Method in interface org.keycloak.models.UserFederationProvider
 
validCredentials(RealmModel, UserCredentialModel) - Method in interface org.keycloak.models.UserFederationProvider
Validate credentials of unknown user.
validCredentials(KeycloakSession, RealmModel, UserModel, List<UserCredentialModel>) - Method in interface org.keycloak.models.UserProvider
 
validCredentials(KeycloakSession, RealmModel, UserModel, UserCredentialModel...) - Method in interface org.keycloak.models.UserProvider
 
validCredentials(KeycloakSession, RealmModel, UserCredentialModel...) - Method in interface org.keycloak.models.UserProvider
 
validCredentials(KeycloakSession, RealmModel, UserModel, List<UserCredentialModel>) - Static method in class org.keycloak.models.utils.CredentialValidation
Must validate all credentials.
validCredentials(KeycloakSession, RealmModel, UserModel, UserCredentialModel...) - Static method in class org.keycloak.models.utils.CredentialValidation
Must validate all credentials.
validHOTP(RealmModel, UserModel, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
validOTP(RealmModel, String, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
validPassword(KeycloakSession, RealmModel, UserModel, String) - Static method in class org.keycloak.models.utils.CredentialValidation
Will update password if hash iteration policy has changed
validPasswordToken(RealmModel, UserModel, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
validSecret(RealmModel, UserModel, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
validTOTP(RealmModel, UserModel, String) - Static method in class org.keycloak.models.utils.CredentialValidation
 
value - Variable in class org.keycloak.models.entities.CredentialEntity
 
value - Variable in class org.keycloak.models.UserCredentialModel
 
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.authorization.model.Policy.DecisionStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.model.Policy.Logic
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.model.ResourceServer.PolicyEnforcementMode
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.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.AuthenticationExecutionModel.Requirement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClientSessionModel.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ClientSessionModel.ExecutionStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserFederationProvider.EditMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserModel.RequiredAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.UserSessionModel.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.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.authorization.model.Policy.DecisionStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.authorization.model.Policy.Logic
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.authorization.model.ResourceServer.PolicyEnforcementMode
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.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.AuthenticationExecutionModel.Requirement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClientSessionModel.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ClientSessionModel.ExecutionStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserFederationProvider.EditMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserModel.RequiredAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.UserSessionModel.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.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(KeycloakSession, RealmModel, String, UserCredentialValueModel) - Static method in class org.keycloak.hash.PasswordHashManager
 
verify(KeycloakSession, PasswordPolicy, String, UserCredentialValueModel) - Static method in class org.keycloak.hash.PasswordHashManager
 
verify(String, UserCredentialValueModel) - Method in interface org.keycloak.hash.PasswordHashProvider
 
verify(String, UserCredentialValueModel) - Method in class org.keycloak.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_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.MigrationTo1_2_0_CR1
 
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.
webOrigins - Variable in class org.keycloak.models.entities.ClientEntity
 
WEBSITE - Static variable in class org.keycloak.models.ClaimMask
 

X

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

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