A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes All Packages

A

ABSTAIN - org.keycloak.services.clientpolicy.ClientPolicyVote
 
AbstractAuthenticationFlowContext - Interface in org.keycloak.authentication
 
AbstractAuthorizationModel - Class in org.keycloak.authorization.model
 
AbstractAuthorizationModel(StoreFactory) - Constructor for class org.keycloak.authorization.model.AbstractAuthorizationModel
 
AbstractClientPolicyConditionProvider<CONFIG extends ClientPolicyConditionConfigurationRepresentation> - Class in org.keycloak.services.clientpolicy.condition
 
AbstractClientPolicyConditionProvider(KeycloakSession) - Constructor for class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider
 
AbstractClientPolicyConditionProviderFactory - Class in org.keycloak.services.clientpolicy.condition
 
AbstractClientPolicyConditionProviderFactory() - Constructor for class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
AbstractConfigPropertySynchronizer<T extends ProviderEvent> - Class in org.keycloak.broker.provider.mappersync
Abstract base class for updating a single reference (specified via a single config property).
AbstractConfigPropertySynchronizer() - Constructor for class org.keycloak.broker.provider.mappersync.AbstractConfigPropertySynchronizer
 
AbstractDecisionCollector - Class in org.keycloak.authorization.policy.evaluation
 
AbstractDecisionCollector() - Constructor for class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
AbstractIdentityProvider<C extends IdentityProviderModel> - Class in org.keycloak.broker.provider
 
AbstractIdentityProvider(KeycloakSession, C) - Constructor for class org.keycloak.broker.provider.AbstractIdentityProvider
 
AbstractIdentityProviderFactory<T extends IdentityProvider> - Class in org.keycloak.broker.provider
 
AbstractIdentityProviderFactory() - Constructor for class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
AbstractIdentityProviderMapper - Class in org.keycloak.broker.provider
 
AbstractIdentityProviderMapper() - Constructor for class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
AbstractLoginProtocolFactory - Class in org.keycloak.protocol
 
AbstractLoginProtocolFactory() - Constructor for class org.keycloak.protocol.AbstractLoginProtocolFactory
 
AbstractNumberValidator - Class in org.keycloak.validate.validators
Abstract class for number validator.
AbstractNumberValidator() - Constructor for class org.keycloak.validate.validators.AbstractNumberValidator
 
AbstractNumberValidator(ValidatorConfig) - Constructor for class org.keycloak.validate.validators.AbstractNumberValidator
 
AbstractSimpleValidator - Class in org.keycloak.validate
Base class for arbitrary value type validators.
AbstractSimpleValidator() - Constructor for class org.keycloak.validate.AbstractSimpleValidator
 
AbstractStringValidator - Class in org.keycloak.validate
Base class for String value format validators.
AbstractStringValidator() - Constructor for class org.keycloak.validate.AbstractStringValidator
 
accept(OutputStream) - Method in interface org.keycloak.exportimport.ExportAdapter.ConsumerOfOutputStream
 
accept(ValidationError) - Method in exception org.keycloak.userprofile.ValidationException
 
acceptJson() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
ACCESS_DENIED - org.keycloak.authentication.AuthenticationFlowError
 
ACCESS_DENIED - Static variable in interface org.keycloak.events.Errors
 
ACCESS_TOKEN_LIFESPAN - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
ACCESS_TOKEN_SIGNED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
ACCOUNT - org.keycloak.forms.account.AccountPages
 
ACCOUNT - org.keycloak.userprofile.UserProfileContext
 
ACCOUNT_CONSOLE_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
ACCOUNT_LINK_URL - Static variable in class org.keycloak.broker.provider.AbstractIdentityProvider
 
ACCOUNT_MANAGEMENT_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
ACCOUNT_OLD - org.keycloak.userprofile.UserProfileContext
 
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
 
ACR_LOA_MAP - Static variable in class org.keycloak.models.Constants
 
action(AuthenticationFlowContext) - Method in interface org.keycloak.authentication.Authenticator
Called from a form action invocation.
ACTION - org.keycloak.events.admin.OperationType
 
ACTION - Static variable in interface org.keycloak.events.Details
 
addAction(RealmModel) - Method in enum org.keycloak.models.utils.DefaultRequiredActions.Action
 
addAction(RealmModel, DefaultRequiredActions.Action) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
Add default required action to the realm
addActions(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
Add default required actions to the realm
addAdminEvent(AdminEvent, boolean) - Method in class org.keycloak.events.EventListenerTransaction
 
addAdminRole(RealmModel, String) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
addAnnotations(Map<String, Object>) - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
addAnnotations(Map<String, Object>) - Method in class org.keycloak.userprofile.AttributeMetadata
 
addAssociatedPolicy(Policy) - Method in interface org.keycloak.authorization.model.Policy
 
addAttribute(String, int, Predicate<AttributeContext>, Predicate<AttributeContext>, AttributeValidatorMetadata...) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttribute(String, int, Predicate<AttributeContext>, List<AttributeValidatorMetadata>) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttribute(String, int, List<AttributeValidatorMetadata>) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttribute(String, int, List<AttributeValidatorMetadata>, Predicate<AttributeContext>, Predicate<AttributeContext>, Predicate<AttributeContext>, Predicate<AttributeContext>) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttribute(String, int, AttributeValidatorMetadata...) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttribute(AttributeMetadata) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addAttributes(List<AttributeMetadata>) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
addClaim(String, String) - Method in class org.keycloak.authorization.permission.ResourcePermission
Adds a permission claim with the given name and a single value.
addClaims(Map<String, Set<String>>) - Method in class org.keycloak.authorization.permission.ResourcePermission
 
addClientScope(ClientScopeModel, boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addClientScopes(Set<ClientScopeModel>, boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addCommonConfigProperties(List<ProviderConfigProperty>) - Static method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
addConfigureTotpAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addCriteria(PropertyCriteria) - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Add a criteria to query
addDefaultClientScopes(RealmModel, Stream<ClientModel>) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
addDefaultClientScopes(RealmModel, ClientModel) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
addDefaultRole(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addDefaults(ClientModel) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
addDeleteAccountAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addError(String) - Method in class org.keycloak.validation.DefaultValidationContext
 
addError(String) - Method in interface org.keycloak.validation.ValidationContext
 
addError(String, String) - Method in class org.keycloak.validation.DefaultValidationContext
 
addError(String, String) - Method in interface org.keycloak.validation.ValidationContext
 
addError(String, String, String, Object...) - Method in class org.keycloak.validation.DefaultValidationContext
 
addError(String, String, String, Object...) - Method in interface org.keycloak.validation.ValidationContext
 
addError(FormMessage) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
addError(ValidationError) - Method in class org.keycloak.validate.ValidationContext
addEvent(Event) - Method in class org.keycloak.events.EventListenerTransaction
 
addFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
addHeaders(ContainerRequestContext, ContainerResponseContext) - Method in interface org.keycloak.headers.SecurityHeadersProvider
 
addIdentityProviderAuthenticator(RealmModel, String) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
addMapperAssignedGroup(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Adds the specified group to the set of groups assigned by mappers.
addMapperGrantedRole(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Adds the specified role to the set of roles granted by mappers.
addOIDCAcrClientScope(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
Add 'acr' client scope or return it if already exists
addOIDCMicroprofileJWTClientScope(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
Adds the microprofile-jwt optional client scope to the realm and returns the created scope.
addOIDCRolesClientScope(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
Add 'roles' client scope or return it if already exists
addOIDCWebOriginsClientScope(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
Add 'web-origins' client scope or return it if already exists
addProtocolMapper(ProtocolMapperModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addProvider(Class<? extends Spi>, ProviderFactory) - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
addReadCondition(Predicate<AttributeContext>) - Method in class org.keycloak.userprofile.AttributeMetadata
 
addRecoveryAuthnCodesAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addRedirectUri(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addRequiredAction(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
addRequiredAction(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
addResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
ADDRESS - Static variable in class org.keycloak.models.ClaimMask
 
addRole(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addRole(String, String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
addScope(Scope) - Method in class org.keycloak.authorization.permission.ResourcePermission
 
addScopeMapping(RoleModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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
addTermsAndConditionsAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addUpdateEmailAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addUpdateLocaleAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addUpdatePasswordAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addUpdateProfileAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addValidator(List<AttributeValidatorMetadata>) - Method in class org.keycloak.userprofile.AttributeMetadata
 
addVerifyEmailAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addWebAuthnPasswordlessRegisterAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addWebAuthnRegisterAction(RealmModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
 
addWebOrigin(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
addWriteCondition(Predicate<AttributeContext>) - Method in class org.keycloak.userprofile.AttributeMetadata
 
ADMIN - Static variable in class org.keycloak.models.AdminRoles
 
ADMIN_CLI_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
ADMIN_CONSOLE_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
AdminEvent - Class in org.keycloak.events.admin
 
AdminEvent() - Constructor for class org.keycloak.events.admin.AdminEvent
 
AdminEvent(AdminEvent) - Constructor for class org.keycloak.events.admin.AdminEvent
 
AdminEvent.SearchableFields - Class in org.keycloak.events.admin
 
AdminEventQuery - Interface in org.keycloak.events.admin
 
AdminRoles - Class in org.keycloak.models
 
AdminRoles() - Constructor for class org.keycloak.models.AdminRoles
 
AIA_SILENT_CANCEL - Static variable in class org.keycloak.models.Constants
 
all(ResourceServer, Identity, AuthorizationProvider, AuthorizationRequest, Consumer<ResourcePermission>) - Static method in class org.keycloak.authorization.permission.Permissions
Returns a list of permissions for all resources and scopes that belong to the given resourceServer and identity.
ALL - org.keycloak.models.utils.reflection.TypedPropertyCriteria.MatchOption
 
ALL - Static variable in class org.keycloak.models.ClaimMask
 
ALL_BUT_LOCAL_DC - org.keycloak.cluster.ClusterProvider.DCNotify
Deprecated.
Send message to all cluster nodes in all datacenters, but NOT to this datacenter.
ALL_DCS - org.keycloak.cluster.ClusterProvider.DCNotify
Deprecated.
Send message to all cluster nodes in all DCs
ALL_QUERY_ROLES - Static variable in class org.keycloak.models.AdminRoles
 
ALL_REALM_ROLES - Static variable in class org.keycloak.models.AdminRoles
 
ALL_ROLES - Static variable in class org.keycloak.models.AdminRoles
 
allowAnyFrameAncestor() - Method in interface org.keycloak.headers.SecurityHeadersOptions
 
allowEmptyContentType() - Method in interface org.keycloak.headers.SecurityHeadersOptions
 
allowFrameSrc(String) - Method in interface org.keycloak.headers.SecurityHeadersOptions
 
ALWAYS_FALSE - Static variable in class org.keycloak.userprofile.AttributeMetadata
 
ALWAYS_TRUE - Static variable in class org.keycloak.userprofile.AttributeMetadata
 
AmphibianProviderFactory<ProviderType extends Provider> - Interface in org.keycloak.component
Ancestor for a provider factory for both a standalone ProviderFactory and a ComponentFactory.
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 - org.keycloak.truststore.HostnameVerificationPolicy
Hostname verification is not done on the server's certificate
ANY_OWNER - org.keycloak.authorization.model.Policy.FilterOption
 
ANY_PROVIDER - Static variable in interface org.keycloak.broker.provider.IdentityProviderMapper
 
APP_SUFFIX - Static variable in class org.keycloak.models.AdminRoles
 
APPLICATIONS - org.keycloak.forms.account.AccountPages
 
applyPolicy(ClientPolicyContext) - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
returns ABSTAIN if this condition is not evaluated due to its nature.
approve(String) - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
approve(String, Map<String, String>) - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
areRequiredActionsEnabled(KeycloakSession, RealmModel) - Method in interface org.keycloak.authentication.Authenticator
Checks if all required actions are configured in the realm and are enabled
ArtifactBindingUtils - Class in org.keycloak.protocol.saml.util
 
ArtifactBindingUtils() - Constructor for class org.keycloak.protocol.saml.util.ArtifactBindingUtils
 
ArtifactResolver - Interface in org.keycloak.protocol.saml
Provides a way to create and resolve artifacts for SAML Artifact binding
ArtifactResolverConfigException - Exception in org.keycloak.protocol.saml
Exception to indicate a configuration error in ArtifactResolver.
ArtifactResolverConfigException(Exception) - Constructor for exception org.keycloak.protocol.saml.ArtifactResolverConfigException
 
ArtifactResolverFactory - Interface in org.keycloak.protocol.saml
A factory that creates ArtifactResolver instances.
ArtifactResolverProcessingException - Exception in org.keycloak.protocol.saml
Exception to indicate a processing error in ArtifactResolver.
ArtifactResolverProcessingException(Exception) - Constructor for exception org.keycloak.protocol.saml.ArtifactResolverProcessingException
 
ArtifactResolverProcessingException(String) - Constructor for exception org.keycloak.protocol.saml.ArtifactResolverProcessingException
 
ArtifactResolverProcessingException(String, Exception) - Constructor for exception org.keycloak.protocol.saml.ArtifactResolverProcessingException
 
ArtifactResolverSpi - Class in org.keycloak.protocol.saml
 
ArtifactResolverSpi() - Constructor for class org.keycloak.protocol.saml.ArtifactResolverSpi
 
artifactToResolverProviderId(String) - Static method in class org.keycloak.protocol.saml.util.ArtifactBindingUtils
 
asDate(int, String) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asDouble(int) - 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
 
asJson() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asJson() - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
asJson(TypeReference<T>) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asJson(TypeReference<T>) - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
asJson(Class<T>) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asJson(Class<T>) - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
asLong(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
asMap() - Method in class org.keycloak.validate.ValidatorConfig
 
asResponse() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
ASSOCIATED_POLICY_ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
asStatus() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asString() - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
asString() - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
asString(int) - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
attachDevice(UserSessionModel, KeycloakSession) - Static method in class org.keycloak.device.DeviceActivityManager
Attaches a device to the given userSession where the device information is obtained from the HttpHeaders.USER_AGENT in the current request, if available.
attachUserSession(UserSessionModel) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
 
attempted() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
There was no failure or challenge.
ATTEMPTED - org.keycloak.authentication.FlowStatus
This is not an error condition.
AttributeChangeListener - Interface in org.keycloak.userprofile
Interface of the user profile attribute change listener.
AttributeContext - Class in org.keycloak.userprofile
 
AttributeContext(UserProfileContext, KeycloakSession, Map.Entry<String, List<String>>, UserModel, AttributeMetadata) - Constructor for class org.keycloak.userprofile.AttributeContext
 
AttributeGroupMetadata - Class in org.keycloak.userprofile
Configuration of the attribute group.
AttributeGroupMetadata(String, String, String, Map<String, Object>) - Constructor for class org.keycloak.userprofile.AttributeGroupMetadata
 
AttributeMetadata - Class in org.keycloak.userprofile
 
Attributes - Interface in org.keycloak.authorization.attribute
Holds attributes, their values and provides utlity methods to manage them.
Attributes - Interface in org.keycloak.userprofile
This interface wraps the attributes associated with a user profile.
Attributes.Entry - Class in org.keycloak.authorization.attribute
Holds an attribute and its values, providing useful methods for obtaining and formatting values.
attributeSet() - Method in interface org.keycloak.userprofile.Attributes
Returns all attributes defined.
attributeSet() - Method in class org.keycloak.userprofile.DefaultAttributes
 
AttributeValidatorMetadata - Class in org.keycloak.userprofile
 
AttributeValidatorMetadata(String) - Constructor for class org.keycloak.userprofile.AttributeValidatorMetadata
 
AttributeValidatorMetadata(String, ValidatorConfig) - Constructor for class org.keycloak.userprofile.AttributeValidatorMetadata
 
AUDIENCE - Static variable in interface org.keycloak.events.Details
 
auth(String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
AUTH_ADMIN_URL_PROP - Static variable in class org.keycloak.models.Constants
 
AUTH_BASE_URL_PROP - Static variable in class org.keycloak.models.Constants
 
AUTH_CLIENT_ID - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
AUTH_EXECUTION - org.keycloak.events.admin.ResourceType
 
AUTH_EXECUTION_FLOW - org.keycloak.events.admin.ResourceType
 
AUTH_FLOW - org.keycloak.events.admin.ResourceType
 
AUTH_IP_ADDRESS - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
AUTH_METHOD - Static variable in interface org.keycloak.events.Details
 
AUTH_REALM_ID - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
AUTH_TYPE - Static variable in interface org.keycloak.events.Details
 
AUTH_TYPE - Static variable in class org.keycloak.models.LDAPConstants
 
AUTH_TYPE_CLIENT_SECRET - Static variable in class org.keycloak.models.utils.KeycloakModelUtils
 
AUTH_TYPE_CLIENT_SECRET_JWT - Static variable in class org.keycloak.models.utils.KeycloakModelUtils
 
AUTH_TYPE_NONE - Static variable in class org.keycloak.models.LDAPConstants
 
AUTH_TYPE_SIMPLE - Static variable in class org.keycloak.models.LDAPConstants
 
AUTH_USER_ID - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
authBasic(String, String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
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
 
AuthDetails(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(AuthenticationSessionModel, UserSessionModel, ClientSessionContext) - Method in interface org.keycloak.protocol.LoginProtocol
 
AUTHENTICATION_ERROR_DETAIL - Static variable in interface org.keycloak.events.Details
 
AUTHENTICATION_EXECUTION - Static variable in class org.keycloak.models.Constants
 
authenticationFinished(AuthenticationSessionModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
authenticationFinished(AuthenticationSessionModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
AuthenticationFlow - Interface in org.keycloak.authentication
 
AuthenticationFlowCallback - Interface in org.keycloak.authentication
Callback to be triggered during various lifecycle events of authentication flow.
AuthenticationFlowCallbackFactory - Interface in org.keycloak.authentication
Factory to create AuthenticationFlowCallback instances.
AuthenticationFlowContext - Interface in org.keycloak.authentication
This interface encapsulates information about an execution in an AuthenticationFlow.
AuthenticationFlowError - Enum in org.keycloak.authentication
Set of error codes that can be thrown by an Authenticator, FormAuthenticator, or FormAction
AuthenticationFlowException - Exception in org.keycloak.authentication
Throw this exception from an Authenticator, FormAuthenticator, or FormAction if you want to completely abort the flow.
AuthenticationFlowException(String, Throwable, boolean, boolean, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(String, Throwable, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(String, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(Throwable, AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(List<AuthenticationFlowException>) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(AuthenticationFlowError) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(AuthenticationFlowError, String, String) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowException(AuthenticationFlowError, Response) - Constructor for exception org.keycloak.authentication.AuthenticationFlowException
 
AuthenticationFlowResolver - Class in org.keycloak.models.utils
 
AuthenticationFlowResolver() - Constructor for class org.keycloak.models.utils.AuthenticationFlowResolver
 
AuthenticationRequest - Class in org.keycloak.broker.provider
 
AuthenticationRequest(KeycloakSession, RealmModel, AuthenticationSessionModel, HttpRequest, UriInfo, IdentityBrokerState, String) - Constructor for class org.keycloak.broker.provider.AuthenticationRequest
 
AuthenticationSelectionOption - Class in org.keycloak.authentication
 
AuthenticationSelectionOption(KeycloakSession, AuthenticationExecutionModel) - Constructor for class org.keycloak.authentication.AuthenticationSelectionOption
 
AuthenticationSessionProviderFactory<T extends AuthenticationSessionProvider> - Interface in org.keycloak.sessions
 
AuthenticationSessionSpi - Class in org.keycloak.sessions
 
AuthenticationSessionSpi() - Constructor for class org.keycloak.sessions.AuthenticationSessionSpi
 
Authenticator - Interface in org.keycloak.authentication
This interface is for users that want to add custom authenticators to an authentication flow.
AUTHENTICATOR_CONFIG - org.keycloak.events.admin.ResourceType
 
AuthenticatorFactory - Interface in org.keycloak.authentication
Factory for creating Authenticator instances.
AuthenticatorSpi - Class in org.keycloak.authentication
 
AuthenticatorSpi() - Constructor for class org.keycloak.authentication.AuthenticatorSpi
 
authIpAddress(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by request ip address
AUTHORIZATION_ENCRYPTED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
AUTHORIZATION_ENCRYPTED_RESPONSE_ENC - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
AUTHORIZATION_POLICY - org.keycloak.events.admin.ResourceType
 
AUTHORIZATION_RESOURCE - org.keycloak.events.admin.ResourceType
 
AUTHORIZATION_RESOURCE_SERVER - org.keycloak.events.admin.ResourceType
 
AUTHORIZATION_SCOPE - org.keycloak.events.admin.ResourceType
 
AUTHORIZATION_SIGNED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
AuthorizationProvider - Class in org.keycloak.authorization
The main contract here is the creation of PermissionEvaluator instances.
AuthorizationProvider(KeycloakSession, RealmModel, PolicyEvaluator) - 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
AUTHREQID_TO_TOKEN - org.keycloak.events.EventType
 
AUTHREQID_TO_TOKEN_ERROR - org.keycloak.events.EventType
 
authUser(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by authenticated user
AUTHZ_DEFAULT_AUTHORIZATION_ROLES - Static variable in class org.keycloak.models.Constants
 
AUTHZ_UMA_AUTHORIZATION - Static variable in class org.keycloak.models.Constants
 
AUTHZ_UMA_PROTECTION - Static variable in class org.keycloak.models.Constants
 

B

BACKCHANNEL_LOGOUT_REVOKE_OFFLINE_TOKENS - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
BACKCHANNEL_LOGOUT_SESSION_REQUIRED - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
BACKCHANNEL_LOGOUT_URL - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
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, AuthenticatedClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
BASE_DN - Static variable in class org.keycloak.models.LDAPConstants
 
BASIC_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
BATCH_SIZE_FOR_SYNC - Static variable in class org.keycloak.models.LDAPConstants
 
BIND_CREDENTIAL - Static variable in class org.keycloak.models.LDAPConstants
 
BIND_DN - Static variable in class org.keycloak.models.LDAPConstants
 
BlacklistPasswordPolicyProvider - Class in org.keycloak.policy
Checks a password against a configured password blacklist.
BlacklistPasswordPolicyProvider(KeycloakContext, BlacklistPasswordPolicyProviderFactory) - Constructor for class org.keycloak.policy.BlacklistPasswordPolicyProvider
 
BlacklistPasswordPolicyProviderFactory - Class in org.keycloak.policy
BlacklistPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist - Class in org.keycloak.policy
BlacklistPasswordPolicyProviderFactory.PasswordBlacklist - Interface in org.keycloak.policy
A BlacklistPasswordPolicyProviderFactory.PasswordBlacklist describes a list of too easy to guess or potentially leaked passwords that users should not be able to use.
BLACKLISTS_PATH_PROPERTY - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
BROKER_SERVICE_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
BROKER_SERVICE_ROLES - Static variable in class 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 - Enum in org.keycloak.models
 
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
 
build() - Method in class org.keycloak.models.ContentSecurityPolicyBuilder
 
build() - Method in class org.keycloak.validate.ValidatorConfig.ValidatorConfigBuilder
 
buildArtifact(AuthenticatedClientSessionModel, String, String) - Method in interface org.keycloak.protocol.saml.ArtifactResolver
Creates and stores an artifact
builder() - Static method in class org.keycloak.validate.ValidatorConfig
 
buildGroupPath(GroupModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
buildGroupPath(GroupModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
buildGroupPath(GroupModel, GroupModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
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.
buildRoleQualifier(String, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
byteArrayToResolverProviderId(byte[]) - Static method in class org.keycloak.protocol.saml.util.ArtifactBindingUtils
 

C

CachedModel<Model> - Interface in org.keycloak.authorization.model
Cached authorization model classes will implement this interface.
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
 
call() - Method in interface org.keycloak.utils.LockObjectsForModification.CallableWithoutThrowingAnException
Computes a result.
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() - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
Called when user cancelled authentication on the IDP side - for example user didn't approve consent page on the IDP side.
CANCELLED - org.keycloak.authentication.RequiredActionContext.KcActionStatus
 
CANCELLED_AIA - org.keycloak.protocol.LoginProtocol.Error
Applications-initiated action was canceled by the user
CANCELLED_AIA_SILENT - org.keycloak.protocol.LoginProtocol.Error
Applications-initiated action was canceled by the user.
CANCELLED_BY_USER - org.keycloak.protocol.LoginProtocol.Error
Login cancelled by the user
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
Cancel task and return the details about it, so it can be eventually restored later
canEdit(AttributeContext) - Method in class org.keycloak.userprofile.AttributeMetadata
 
canView(AttributeContext) - Method in class org.keycloak.userprofile.AttributeMetadata
 
CekManagementProvider - Interface in org.keycloak.crypto
 
CekManagementProviderFactory - Interface in org.keycloak.crypto
 
CekManagementSpi - Class in org.keycloak.crypto
 
CekManagementSpi() - Constructor for class org.keycloak.crypto.CekManagementSpi
 
CFG_DELIMITER - Static variable in class org.keycloak.models.Constants
 
CFG_DELIMITER_PATTERN - Static variable in class org.keycloak.models.Constants
 
CFG_ERROR_MESSAGE - Static variable in class org.keycloak.validate.validators.PatternValidator
 
CFG_PATTERN - Static variable in class org.keycloak.validate.validators.PatternValidator
 
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
CHALLENGE - org.keycloak.authentication.FlowStatus
Execution offered a challenge.
CHALLENGE - org.keycloak.authentication.RequiredActionContext.Status
 
check(ComponentModel) - Static method in class org.keycloak.provider.ConfigurationValidationHelper
 
check(KeycloakSession, X509Certificate, X509Certificate) - Method in class org.keycloak.utils.OCSPProvider
Requests certificate revocation status using OCSP.
check(KeycloakSession, X509Certificate, X509Certificate, URI, X509Certificate, Date) - Method in class org.keycloak.utils.OCSPProvider
Requests certificate revocation status using OCSP.
check(KeycloakSession, X509Certificate, X509Certificate, Date, X509Certificate) - Method in class org.keycloak.utils.OCSPProvider
Requests certificate revocation status using OCSP.
check(KeycloakSession, X509Certificate, X509Certificate, List<URI>, X509Certificate, Date) - Method in class org.keycloak.utils.OCSPProvider
Requests certificate revocation status using OCSP.
checkBoolean(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkBoolean(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkForcedUnlock() - Method in class org.keycloak.models.dblock.DBLockManager
 
checkInt(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkInt(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkKeyForSignature(KeyWrapper, String, String) - Static method in interface org.keycloak.crypto.SignatureProvider
 
checkKeyForVerification(KeyWrapper, String, String) - Static method in interface org.keycloak.crypto.SignatureProvider
 
checkList(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkLong(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkLong(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkRequired(String, String) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkRequired(ProviderConfigProperty) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkSingle(String, String, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
checkSingle(ProviderConfigProperty, boolean) - Method in class org.keycloak.provider.ConfigurationValidationHelper
 
ClaimMask - Class in org.keycloak.models
 
ClaimMask() - Constructor for class org.keycloak.models.ClaimMask
 
cleanUpPermanentLockout(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.services.managers.BruteForceProtector
Clears any remaining traces of the permanent lockout.
clear() - Method in interface org.keycloak.events.EventStoreProvider
Deprecated.
Unused method. Currently, used only in the testsuite
clear(RealmModel) - Method in interface org.keycloak.events.EventStoreProvider
Removes all auth events for the realm from this store provider.
clear(RealmModel, long) - Method in interface org.keycloak.events.EventStoreProvider
Removes all auth events for the realm that are older than olderThan from this store provider.
clearAdmin() - Method in interface org.keycloak.events.EventStoreProvider
Deprecated.
Unused method. Currently, used only in the testsuite
clearAdmin(RealmModel) - Method in interface org.keycloak.events.EventStoreProvider
Removes all auth events for the realm from this store provider.
clearAdmin(RealmModel, long) - Method in interface org.keycloak.events.EventStoreProvider
Removes all auth events for the realm that are older than olderThan from this store provider.
clearExpiredEvents() - Method in interface org.keycloak.events.EventStoreProvider
Deprecated.
This method is problem from the performance perspective. Some storages can provide better way for doing this (e.g. entry lifespan in the Infinispan server, etc.). We need to leave solving event expiration to each storage provider separately using expiration field on entity level.
clearUser() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Clear the user from the flow.
client - Variable in class org.keycloak.models.ClientConfigResolver
 
client(String) - Method in class org.keycloak.events.EventBuilder
 
client(String) - Method in interface org.keycloak.events.EventQuery
Search events for only one client
client(ClientModel) - Method in class org.keycloak.events.EventBuilder
 
CLIENT - org.keycloak.events.admin.ResourceType
 
CLIENT_AUTH_METHOD - Static variable in interface org.keycloak.events.Details
 
CLIENT_AUTHENTICATION_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
CLIENT_CREDENTIALS_SETUP_REQUIRED - org.keycloak.authentication.AuthenticationFlowError
 
CLIENT_DELETE - org.keycloak.events.EventType
 
CLIENT_DELETE_ERROR - org.keycloak.events.EventType
 
CLIENT_DISABLED - org.keycloak.authentication.AuthenticationFlowError
 
CLIENT_DISABLED - Static variable in interface org.keycloak.events.Errors
 
CLIENT_FLOW - Static variable in interface org.keycloak.authentication.AuthenticationFlow
 
CLIENT_ID - Static variable in class org.keycloak.authorization.model.ResourceServer.SearchableFields
ID of the client (not the clientId) associated with resource server
CLIENT_ID - Static variable in class org.keycloak.events.Event.SearchableFields
 
CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
CLIENT_INFO - org.keycloak.events.EventType
 
CLIENT_INFO_ERROR - org.keycloak.events.EventType
 
CLIENT_INITIAL_ACCESS_MODEL - org.keycloak.events.admin.ResourceType
 
CLIENT_INITIATED_ACCOUNT_LINKING - org.keycloak.events.EventType
 
CLIENT_INITIATED_ACCOUNT_LINKING_ERROR - org.keycloak.events.EventType
 
CLIENT_LOGIN - org.keycloak.events.EventType
 
CLIENT_LOGIN_ERROR - org.keycloak.events.EventType
 
CLIENT_NOT_FOUND - org.keycloak.authentication.AuthenticationFlowError
 
CLIENT_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
CLIENT_OFFLINE_SESSION_IDLE_TIMEOUT - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
CLIENT_OFFLINE_SESSION_MAX_LIFESPAN - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
CLIENT_POLICIES - Static variable in class org.keycloak.models.Constants
 
CLIENT_PROFILES - Static variable in class org.keycloak.models.Constants
 
CLIENT_REGISTER - org.keycloak.events.EventType
 
CLIENT_REGISTER_ERROR - org.keycloak.events.EventType
 
CLIENT_REGISTRATION_POLICY - Static variable in interface org.keycloak.events.Details
 
CLIENT_ROLE - org.keycloak.events.admin.ResourceType
 
CLIENT_ROLE_MAPPING - org.keycloak.events.admin.ResourceType
 
CLIENT_ROTATED_SECRET - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_ROTATED_SECRET_CREATION_TIME - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_ROTATED_SECRET_EXPIRATION_TIME - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_SCOPE - org.keycloak.events.admin.ResourceType
 
CLIENT_SCOPE_CLIENT_MAPPING - org.keycloak.events.admin.ResourceType
 
CLIENT_SCOPE_MAPPING - org.keycloak.events.admin.ResourceType
 
CLIENT_SECRET_CREATION_TIME - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_SECRET_EXPIRATION - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_SECRET_REMAINING_EXPIRATION_TIME - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_SECRET_ROTATION_ENABLED - Static variable in class org.keycloak.models.ClientSecretConstants
 
CLIENT_SESSION_IDLE_TIMEOUT - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
CLIENT_SESSION_MAX_LIFESPAN - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
CLIENT_UPDATE - org.keycloak.events.EventType
 
CLIENT_UPDATE_ERROR - org.keycloak.events.EventType
 
ClientApplicationSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
ClientApplicationSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.ClientApplicationSynchronizer
 
ClientAuthenticationFlowContext - Interface in org.keycloak.authentication
Encapsulates information about the execution in ClientAuthenticationFlow
ClientAuthenticator - Interface in org.keycloak.authentication
This interface is for users that want to add custom client authenticators to an authentication flow.
ClientAuthenticatorFactory - Interface in org.keycloak.authentication
Factory for creating ClientAuthenticator instances.
ClientAuthenticatorSpi - Class in org.keycloak.authentication
 
ClientAuthenticatorSpi() - Constructor for class org.keycloak.authentication.ClientAuthenticatorSpi
 
clientAuthFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
ClientConfigResolver - Class in org.keycloak.models
TODO: remove this class entirely?
ClientConfigResolver(ClientModel) - Constructor for class org.keycloak.models.ClientConfigResolver
 
ClientInstallationProvider - Interface in org.keycloak.protocol
Provides a template/sample client config adapter file.
ClientInstallationSpi - Class in org.keycloak.protocol
 
ClientInstallationSpi() - Constructor for class org.keycloak.protocol.ClientInstallationSpi
 
ClientModelLazyDelegate - Class in org.keycloak.models.delegate
 
ClientModelLazyDelegate(Supplier<ClientModel>) - Constructor for class org.keycloak.models.delegate.ClientModelLazyDelegate
 
ClientModelLazyDelegate.WithId - Class in org.keycloak.models.delegate
 
ClientPolicyConditionProvider<CONFIG extends ClientPolicyConditionConfigurationRepresentation> - Interface in org.keycloak.services.clientpolicy.condition
This condition determines to which client a client policy is adopted.
ClientPolicyConditionProviderFactory - Interface in org.keycloak.services.clientpolicy.condition
 
ClientPolicyConditionSpi - Class in org.keycloak.services.clientpolicy.condition
 
ClientPolicyConditionSpi() - Constructor for class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
ClientPolicyExecutorProvider<CONFIG extends ClientPolicyExecutorConfigurationRepresentation> - Interface in org.keycloak.services.clientpolicy.executor
This executor specifies what action is executed on the client to which a client policy is adopted.
ClientPolicyExecutorProviderFactory - Interface in org.keycloak.services.clientpolicy.executor
 
ClientPolicyExecutorSpi - Class in org.keycloak.services.clientpolicy.executor
 
ClientPolicyExecutorSpi() - Constructor for class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
ClientPolicyManagerFactory - Interface in org.keycloak.services.clientpolicy
 
ClientPolicyManagerSpi - Class in org.keycloak.services.clientpolicy
 
ClientPolicyManagerSpi() - Constructor for class org.keycloak.services.clientpolicy.ClientPolicyManagerSpi
 
ClientPolicyVote - Enum in org.keycloak.services.clientpolicy
 
ClientProviderFactory<T extends ClientProvider> - Interface in org.keycloak.models
 
clients() - Method in interface org.keycloak.storage.DatastoreProvider
 
ClientScopeProviderFactory<T extends ClientScopeProvider> - Interface in org.keycloak.models
 
clientScopes() - Method in interface org.keycloak.storage.DatastoreProvider
 
ClientScopeSpi - Class in org.keycloak.models
 
ClientScopeSpi() - Constructor for class org.keycloak.models.ClientScopeSpi
 
ClientSecretConstants - Class in org.keycloak.models
 
ClientSecretConstants() - Constructor for class org.keycloak.models.ClientSecretConstants
 
ClientSignatureVerifierProvider - Interface in org.keycloak.crypto
 
ClientSignatureVerifierProviderFactory - Interface in org.keycloak.crypto
 
ClientSignatureVerifierSpi - Class in org.keycloak.crypto
 
ClientSignatureVerifierSpi() - Constructor for class org.keycloak.crypto.ClientSignatureVerifierSpi
 
ClientSpi - Class in org.keycloak.models
 
ClientSpi() - Constructor for class org.keycloak.models.ClientSpi
 
ClientValidationContext - Class in org.keycloak.validation
 
ClientValidationContext(ValidationContext.Event, KeycloakSession, ClientModel) - Constructor for class org.keycloak.validation.ClientValidationContext
 
ClientValidationContext.OIDCContext - Class in org.keycloak.validation
 
ClientValidationProvider - Interface in org.keycloak.validation
 
ClientValidationProviderFactory - Interface in org.keycloak.validation
 
ClientValidationSPI - Class in org.keycloak.validation
 
ClientValidationSPI() - Constructor for class org.keycloak.validation.ClientValidationSPI
 
clone() - Method in class org.keycloak.events.Event
 
clone() - Method in class org.keycloak.events.EventBuilder
 
clone() - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
clone() - Method in class org.keycloak.userprofile.AttributeMetadata
 
clone() - Method in class org.keycloak.userprofile.UserProfileMetadata
 
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.broker.provider.util.SimpleHttp.Response
 
close() - Method in interface org.keycloak.component.AmphibianProviderFactory
 
close() - Method in interface org.keycloak.component.ComponentFactoryProvider
 
close() - Method in interface org.keycloak.credential.CredentialProviderFactory
 
close() - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
close() - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
close() - Method in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
close() - Method in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
close() - Method in interface org.keycloak.crypto.CekManagementProvider
 
close() - Method in interface org.keycloak.crypto.CekManagementProviderFactory
 
close() - Method in interface org.keycloak.crypto.ClientSignatureVerifierProvider
 
close() - Method in interface org.keycloak.crypto.ClientSignatureVerifierProviderFactory
 
close() - Method in interface org.keycloak.crypto.ContentEncryptionProvider
 
close() - Method in interface org.keycloak.crypto.ContentEncryptionProviderFactory
 
close() - Method in interface org.keycloak.crypto.HashProvider
 
close() - Method in interface org.keycloak.crypto.HashProviderFactory
 
close() - Method in interface org.keycloak.crypto.SignatureProvider
 
close() - Method in interface org.keycloak.crypto.SignatureProviderFactory
 
close() - Method in interface org.keycloak.headers.SecurityHeadersProvider
 
close() - Method in interface org.keycloak.headers.SecurityHeadersProviderFactory
 
close() - Method in interface org.keycloak.keys.KeyProvider
 
close() - Method in interface org.keycloak.keys.KeyProviderFactory
 
close() - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
close() - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProvider
 
close() - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
close() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
close() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
close() - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
close() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
close() - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
close() - Method in interface org.keycloak.provider.ExceptionConverter
 
close() - Method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
close() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
 
close() - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
 
close() - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
close() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
close() - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
close() - Method in class org.keycloak.utils.LockObjectsForModification.Enabled
 
close() - Method in interface org.keycloak.validate.SimpleValidator
 
close() - Method in interface org.keycloak.validate.Validator
 
close() - Method in interface org.keycloak.validate.ValidatorFactory
This is called when the server shuts down.
close() - Method in interface org.keycloak.validation.ClientValidationProvider
 
close() - Method in interface org.keycloak.validation.ClientValidationProviderFactory
 
closing(Stream<T>) - Static method in class org.keycloak.utils.StreamsUtil
Returns the original stream that is closed on terminating operation.
CLUSTER_NODE - org.keycloak.events.admin.ResourceType
 
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
Deprecated.
This is only available when the legacy store is enabled. Support for this will be eventually removed.
ClusterProvider.DCNotify - Enum in org.keycloak.cluster
Deprecated.
 
CN - Static variable in class org.keycloak.models.LDAPConstants
 
CODE - org.keycloak.forms.login.LoginFormsPages
 
CODE_ID - Static variable in interface org.keycloak.events.Details
 
CODE_TO_TOKEN - org.keycloak.events.EventType
 
CODE_TO_TOKEN_ERROR - org.keycloak.events.EventType
 
CODE_VERIFIER_MISSING - Static variable in interface org.keycloak.events.Errors
 
combineIdpAndMapperSyncMode(IdentityProviderSyncMode, IdentityProviderMapperSyncMode) - Static method in class org.keycloak.broker.provider.IdentityProviderMapperSyncModeDelegate
 
COMMA - Static variable in class org.keycloak.models.LDAPConstants
 
commitImpl() - Method in class org.keycloak.events.EventListenerTransaction
 
commonConfig() - Static method in class org.keycloak.storage.role.RoleStorageProviderSpi
 
COMPONENT - org.keycloak.events.admin.ResourceType
 
ComponentFactoryProvider - Interface in org.keycloak.component
 
ComponentFactoryProviderFactory - Interface in org.keycloak.component
 
ComponentFactorySpi - Class in org.keycloak.component
 
ComponentFactorySpi() - Constructor for class org.keycloak.component.ComponentFactorySpi
 
componentModelGetter(String, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
ComponentModelScope - Class in org.keycloak.component
 
ComponentModelScope(Config.Scope, ComponentModel) - Constructor for class org.keycloak.component.ComponentModelScope
 
ComponentModelScope(Config.Scope, ComponentModel, String) - Constructor for class org.keycloak.component.ComponentModelScope
 
ComponentUtil - Class in org.keycloak.models.utils
 
ComponentUtil() - Constructor for class org.keycloak.models.utils.ComponentUtil
 
computeArtifactBindingIdentifier(String) - Static method in class org.keycloak.protocol.saml.util.ArtifactBindingUtils
Computes 20 bytes long byte identifier of the given string, for example, from entityId
computeArtifactBindingIdentifierString(String) - Static method in class org.keycloak.protocol.saml.util.ArtifactBindingUtils
Computes identifier from the given String, for example, from entityId
config(String, Object) - Method in class org.keycloak.validate.ValidatorConfig.ValidatorConfigBuilder
 
config(Map<String, Object>) - Method in class org.keycloak.validate.ValidatorConfig.ValidatorConfigBuilder
Add all configurations from map
config(ValidatorConfig) - Method in class org.keycloak.validate.ValidatorConfig.ValidatorConfigBuilder
Add all configurations from other config
CONFIG - org.keycloak.authorization.model.Policy.FilterOption
 
CONFIG - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
CONFIG_SEPARATOR - Static variable in interface org.keycloak.authorization.model.Policy
 
ConfigConstants - Interface in org.keycloak.broker.provider
 
configFromMap(Map<String, Object>) - Static method in class org.keycloak.validate.ValidatorConfig
Static helper to create a ValidatorConfig from the given map.
configProperties - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
ConfigSyncEventListener - Class in org.keycloak.broker.provider.mappersync
Event listener which synchronizes mapper configs, when references change.
ConfigSyncEventListener() - Constructor for class org.keycloak.broker.provider.mappersync.ConfigSyncEventListener
 
ConfigSynchronizer<T extends ProviderEvent> - Interface in org.keycloak.broker.provider.mappersync
Interface for updating references in mapper configs, when references (like group path) change.
ConfigurableAuthenticatorFactory - Interface in org.keycloak.authentication
 
configuration - Variable in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider
 
ConfigurationValidationHelper - Class in org.keycloak.provider
 
CONFIGURE_RECOVERY_AUTHN_CODES - org.keycloak.models.utils.DefaultRequiredActions.Action
 
CONFIGURE_TOTP - org.keycloak.models.utils.DefaultRequiredActions.Action
 
configureBindings(Bindings) - Method in interface org.keycloak.scripting.ScriptBindingsConfigurer
 
configuredFor(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.Authenticator
Is this authenticator configured for this user.
configuredFor(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.FormAction
Is this FormAction configured for the current user?
CONNECTION_POOLING - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_AUTHENTICATION - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_DEBUG - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_INITSIZE - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_MAXSIZE - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_PREFSIZE - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_PROTOCOL - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_POOLING_TIMEOUT - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_TIMEOUT - Static variable in class org.keycloak.models.LDAPConstants
 
CONNECTION_URL - Static variable in class org.keycloak.models.LDAPConstants
 
connectionRequestTimeoutMillis(int) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
connectTimeoutMillis(int) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
CONSENT - Static variable in interface org.keycloak.events.Details
 
CONSENT_DENIED - org.keycloak.protocol.LoginProtocol.Error
Consent denied by the user
CONSENT_DENIED - Static variable in interface org.keycloak.events.Errors
 
CONSENT_VALUE_CONSENT_GRANTED - Static variable in interface org.keycloak.events.Details
 
CONSENT_VALUE_NO_CONSENT_REQUIRED - Static variable in interface org.keycloak.events.Details
 
CONSENT_VALUE_PERSISTED_CONSENT - Static variable in interface org.keycloak.events.Details
 
Constants - Class in org.keycloak.models
 
Constants() - Constructor for class org.keycloak.models.Constants
 
contains(String) - Method in interface org.keycloak.models.SingleUseObjectProvider
Checks if there is a record in the store for the given key.
contains(String) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist
 
contains(String) - Method in interface org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.PasswordBlacklist
Checks whether a given password is contained in this BlacklistPasswordPolicyProviderFactory.PasswordBlacklist.
contains(String) - Method in interface org.keycloak.userprofile.Attributes
Checks whether an attribute with the given name is defined.
contains(String) - Method in class org.keycloak.userprofile.DefaultAttributes
 
containsKey(String) - Method in class org.keycloak.validate.ValidatorConfig
 
containsValue(String, String) - Method in interface org.keycloak.authorization.attribute.Attributes
Checks if there is an attribute with the given name and value.
CONTENT_SECURITY_POLICY - org.keycloak.models.BrowserSecurityHeaders
 
CONTENT_SECURITY_POLICY_REPORT_ONLY - org.keycloak.models.BrowserSecurityHeaders
 
ContentEncryptionProvider - Interface in org.keycloak.crypto
 
ContentEncryptionProviderFactory - Interface in org.keycloak.crypto
 
ContentEncryptionSpi - Class in org.keycloak.crypto
 
ContentEncryptionSpi() - Constructor for class org.keycloak.crypto.ContentEncryptionSpi
 
ContentSecurityPolicyBuilder - Class in org.keycloak.models
 
ContentSecurityPolicyBuilder() - Constructor for class org.keycloak.models.ContentSecurityPolicyBuilder
 
context - Variable in class org.keycloak.userprofile.DefaultAttributes
 
CONTEXT - Static variable in interface org.keycloak.events.Details
 
convert(Object, ValidatorConfig) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
Convert input value to instance of Number supported by this validator.
convert(Object, ValidatorConfig) - Method in class org.keycloak.validate.validators.DoubleValidator
 
convert(Object, ValidatorConfig) - Method in class org.keycloak.validate.validators.IntegerValidator
 
convert(Throwable) - Method in interface org.keycloak.provider.ExceptionConverter
Return null if the provider doesn't handle this type
convertClientScopeName(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Replace spaces in the name with underscore, so that scope name can be used as value of scope parameter
COOKIE_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
count(ResourceServer, Map<PermissionTicket.FilterOption, String>) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns count of PermissionTicket, filtered by the given attributes.
create() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
 
create() - Static method in class org.keycloak.models.ContentSecurityPolicyBuilder
 
create() - Static method in class org.keycloak.provider.KeycloakDeploymentInfo
 
create() - Method in class org.keycloak.userprofile.DefaultUserProfile
 
create() - Method in interface org.keycloak.userprofile.UserProfile
Creates a new UserModel based on the attributes associated with this instance.
create(AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
create(ResourceServer, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Creates a new Scope instance.
create(ResourceServer, String, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Creates a Resource instance backed by this persistent storage implementation.
create(ResourceServer, String, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Creates a new Scope instance.
create(ResourceServer, String, String, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Creates a Resource instance backed by this persistent storage implementation.
create(ResourceServer, Resource, Scope, String) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Creates a new PermissionTicket instance.
create(ResourceServer, AbstractPolicyRepresentation) - Method in interface org.keycloak.authorization.store.PolicyStore
Creates a new Policy instance.
create(ClientModel) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Creates a ResourceServer instance backed by this persistent storage implementation.
create(KeycloakSession) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
create(KeycloakSession) - Method in interface org.keycloak.component.AmphibianProviderFactory
 
create(KeycloakSession) - Method in interface org.keycloak.component.ComponentFactoryProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
create(KeycloakSession) - Method in interface org.keycloak.provider.ExceptionConverter
 
create(KeycloakSession) - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
create(KeycloakSession) - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
create(KeycloakSession) - Method in interface org.keycloak.validate.SimpleValidator
 
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.component.AmphibianProviderFactory
Deprecated.
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.keys.KeyProviderFactory
 
create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
called per Keycloak transaction.
create(KeycloakSession, IdentityProviderModel) - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates an IdentityProvider based on the configuration contained in model.
create(KeycloakSession, RealmModel) - Method in interface org.keycloak.authorization.AuthorizationProviderFactory
 
create(RealmModel, ClientModel, String, String, String, int, int, String, String, Map<String, String>, String, String) - Static method in class org.keycloak.models.OAuth2DeviceCodeModel
 
create(KeycloakDeploymentInfo, ClassLoader, String) - Method in interface org.keycloak.provider.ProviderLoaderFactory
 
create(UserProfileContext, Map<String, ?>) - Method in interface org.keycloak.userprofile.UserProfileProvider
Creates a new UserProfile instance for a given context and attributes for validation purposes.
create(UserProfileContext, Map<String, ?>, UserModel) - Method in interface org.keycloak.userprofile.UserProfileProvider
Creates a new UserProfile instance for a given context and attributes for update purposes.
create(UserProfileContext, UserModel) - Method in interface org.keycloak.userprofile.UserProfileProvider
Creates a new UserProfile instance only for validation purposes to check whether its attributes are in conformance with the given context and profile configuration.
CREATE - org.keycloak.events.admin.OperationType
 
CREATE - org.keycloak.validation.ValidationContext.Event
 
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
Returns an object representing admin event query of type AdminEventQuery.
createAesProvider(RealmModel) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createAttributeContext(AttributeMetadata) - Method in class org.keycloak.userprofile.DefaultAttributes
 
createClient(KeycloakSession, RealmModel, ClientRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
Does not create scope or role mappings!
createClient(KeycloakSession, RealmModel, ClientRepresentation, Map<String, String>) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createClientScope(KeycloakSession, RealmModel, ClientScopeRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createCode() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createComponentModel(String, String, String, String, String...) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createConfig() - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates a provider specific IdentityProviderModel instance.
createCredentials(UserRepresentation, KeycloakSession, RealmModel, UserModel, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createDefaultClientScopes(KeycloakSession, RealmModel, boolean) - Static method in class org.keycloak.models.utils.DefaultClientScopes
 
createDefaultClientScopes(RealmModel, boolean) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
createDefaultClientScopes(RealmModel, boolean) - Method in interface org.keycloak.protocol.LoginProtocolFactory
Called when new realm is created
createDefaultClientScopesImpl(RealmModel) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
Impl should create default client scopes.
createErrorPage(Response.Status) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createFallbackKeys(KeycloakSession, KeyUse, String) - Method in interface org.keycloak.keys.KeyProviderFactory
 
createFederatedIdentities(UserRepresentation, KeycloakSession, RealmModel, UserModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createForm(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createFrontChannelLogoutPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createGroups(UserRepresentation, RealmModel, UserModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
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
 
createKey(String) - Static method in class org.keycloak.models.OAuth2DeviceCodeModel
 
createKey(RealmModel, String) - Static method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
createLoginExpiredPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginPassword() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginRecoveryAuthnCode() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginTotp() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginUsername() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginUsernamePassword() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLoginWebAuthn() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createLogoutConfirmPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createManagementClient(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createOAuth2DeviceVerifyUserCodePage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createOAuthGrant() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createOfflineAccessClientScope(RealmModel, RoleModel) - Static method in class org.keycloak.models.utils.DefaultClientScopes
 
createOTPCredential(KeycloakSession, RealmModel, UserModel, String, OTPCredentialModel) - Static method in class org.keycloak.utils.CredentialHelper
Create OTP credential either in userStorage or local storage (Keycloak DB)
createPasswordReset() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createProperty(Method) - Static method in class org.keycloak.models.utils.reflection.Properties
Create a JavaBean style property from the specified method
createProtocolEndpoint(RealmModel, EventBuilder) - Method in interface org.keycloak.protocol.LoginProtocolFactory
 
createProviders(RealmModel) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createProviders(RealmModel, String, String) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createPublicClient(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
createQuery() - Method in interface org.keycloak.events.EventStoreProvider
Returns an object representing auth event query of type EventQuery.
createQuery(Class<?>) - Static method in class org.keycloak.models.utils.reflection.PropertyQueries
Create a new PropertyQuery
createRegistration() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createResourcePermissions(Resource, ResourceServer, Collection<Scope>, AuthorizationProvider, AuthorizationRequest) - Static method in class org.keycloak.authorization.permission.Permissions
 
createResourceServer(ClientModel, KeycloakSession, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
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
 
createSamlPostForm() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createScript(String, String, String, String, String) - Method in interface org.keycloak.scripting.ScriptingProvider
Creates a new ScriptModel instance.
createSecretProvider(RealmModel) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
createSelectAuthenticator() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createUpdateProfilePage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createUser(KeycloakSession, RealmModel, UserRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
createUser(RealmModel, UserRepresentation) - Method in interface org.keycloak.storage.ExportImportManager
 
createUserStorageCredentialRepresentation(String) - Static method in class org.keycloak.utils.CredentialHelper
Create "dummy" representation of the credential.
createWebAuthnErrorPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
createX509ConfirmPage() - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
CREDENTIAL_ID - Static variable in class org.keycloak.models.Constants
 
CREDENTIAL_SETUP_REQUIRED - org.keycloak.authentication.AuthenticationFlowError
 
CREDENTIAL_TYPE - Static variable in interface org.keycloak.events.Details
 
CredentialHelper - Class in org.keycloak.utils
used to set an execution a state based on type.
CredentialHelper() - Constructor for class org.keycloak.utils.CredentialHelper
 
CredentialProviderFactory<T extends CredentialProvider> - Interface in org.keycloak.credential
 
CredentialRegistrator - Interface in org.keycloak.authentication
 
CredentialSpi - Class in org.keycloak.credential
 
CredentialSpi() - Constructor for class org.keycloak.credential.CredentialSpi
 
CredentialValidation - Class in org.keycloak.models.utils
 
CredentialValidation() - Constructor for class org.keycloak.models.utils.CredentialValidation
 
CredentialValidator<T extends CredentialProvider> - Interface in org.keycloak.authentication
 
CUSTOM - org.keycloak.events.admin.ResourceType
 
CUSTOM_ATTRIBUTE_CREATE_DATE - Static variable in class org.keycloak.models.LDAPConstants
 
CUSTOM_ATTRIBUTE_EXPIRY_DATE - Static variable in class org.keycloak.models.LDAPConstants
 
CUSTOM_REQUIRED_ACTION - org.keycloak.events.EventType
 
CUSTOM_REQUIRED_ACTION - Static variable in interface org.keycloak.events.Details
 
CUSTOM_REQUIRED_ACTION_ERROR - org.keycloak.events.EventType
 
CUSTOM_USER_SEARCH_FILTER - Static variable in class org.keycloak.models.LDAPConstants
 

D

DATABASE - org.keycloak.models.dblock.DBLockProvider.Namespace
 
DatastoreProvider - Interface in org.keycloak.storage
 
DatastoreProviderFactory - Interface in org.keycloak.storage
 
DatastoreSpi - Class in org.keycloak.storage
 
DatastoreSpi() - Constructor for class org.keycloak.storage.DatastoreSpi
 
dateValidator() - Static method in class org.keycloak.validate.Validators
 
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.
DBLockProvider.Namespace - Enum in org.keycloak.models.dblock
Lock namespace to have different lock types or contexts.
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
 
DecisionPermissionCollector - Class in org.keycloak.authorization.policy.evaluation
 
DecisionPermissionCollector(AuthorizationProvider, ResourceServer, AuthorizationRequest) - Constructor for class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
DecisionResultCollector - Class in org.keycloak.authorization.policy.evaluation
 
DecisionResultCollector() - Constructor for class org.keycloak.authorization.policy.evaluation.DecisionResultCollector
 
decoded(String, String, String, String) - Static method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
decodeSessionId(String) - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
decodeSessionId(String) - Method in interface org.keycloak.sessions.StickySessionEncoderProvider
 
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 - Static variable in interface org.keycloak.models.AccountRoles
 
DEFAULT_ACCESS_TOKEN_LIFESPAN_FOR_IMPLICIT_FLOW_TIMEOUT - Static variable in class org.keycloak.models.Constants
 
DEFAULT_ACR_VALUES - Static variable in class org.keycloak.models.Constants
 
DEFAULT_ALLOW_FRAGMENT - Static variable in class org.keycloak.validate.validators.UriValidator
 
DEFAULT_ALLOWED_SCHEMES - Static variable in class org.keycloak.validate.validators.UriValidator
 
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_DERIVED_KEY_SIZE - Static variable in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES - Static variable in interface org.keycloak.broker.provider.IdentityProviderMapper
 
DEFAULT_INTERVAL_SECONDS - Static variable in class org.keycloak.models.utils.TimeBasedOTP
 
DEFAULT_ITERATIONS - Static variable in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
DEFAULT_ITERATIONS - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
DEFAULT_ITERATIONS - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
DEFAULT_MAX_LENGTH - Static variable in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
DEFAULT_MAX_RESULTS - Static variable in class org.keycloak.models.Constants
 
DEFAULT_OFFLINE_SESSION_IDLE_TIMEOUT - Static variable in class org.keycloak.models.Constants
 
DEFAULT_OFFLINE_SESSION_MAX_LIFESPAN - Static variable in class org.keycloak.models.Constants
 
DEFAULT_REQUIRE_VALID_URL - Static variable in class org.keycloak.validate.validators.UriValidator
 
DEFAULT_ROLES_ROLE_PREFIX - Static variable in class org.keycloak.models.Constants
 
DEFAULT_SIGNATURE_ALGORITHM - Static variable in class org.keycloak.models.Constants
 
DEFAULT_VALUE - Static variable in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
DEFAULT_VALUE - Static variable in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
DEFAULT_WEBAUTHN_POLICY_NOT_SPECIFIED - Static variable in class org.keycloak.models.Constants
 
DEFAULT_WEBAUTHN_POLICY_RP_ENTITY_NAME - Static variable in class org.keycloak.models.Constants
 
DEFAULT_WEBAUTHN_POLICY_SIGNATURE_ALGORITHMS - Static variable in class org.keycloak.models.Constants
 
DefaultAttributes - Class in org.keycloak.userprofile
The default implementation for Attributes.
DefaultAttributes(UserProfileContext, Map<String, ?>, UserModel, UserProfileMetadata, KeycloakSession) - Constructor for class org.keycloak.userprofile.DefaultAttributes
 
DefaultAuthenticationFlows - Class in org.keycloak.models.utils
 
DefaultAuthenticationFlows() - Constructor for class org.keycloak.models.utils.DefaultAuthenticationFlows
 
defaultClients - Static variable in class org.keycloak.models.Constants
 
DefaultClientScopes - Class in org.keycloak.models.utils
 
DefaultClientScopes() - Constructor for class org.keycloak.models.utils.DefaultClientScopes
 
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, Decision, AuthorizationProvider) - Constructor for class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
DefaultEvaluation(ResourcePermission, EvaluationContext, Policy, Decision, AuthorizationProvider, Map<Policy, Map<Object, Decision.Effect>>) - Constructor for class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
DefaultEvaluation(ResourcePermission, EvaluationContext, Policy, Policy, Decision, AuthorizationProvider, Map<Policy, Map<Object, Decision.Effect>>) - Constructor for class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
DefaultKeyProviders - Class in org.keycloak.models.utils
 
DefaultKeyProviders() - Constructor for class org.keycloak.models.utils.DefaultKeyProviders
 
DefaultOAuth2DeviceUserCodeProvider - Class in org.keycloak.models
The default implementation for generating/formatting user code of OAuth 2.0 Device Authorization Grant.
DefaultOAuth2DeviceUserCodeProvider() - Constructor for class org.keycloak.models.DefaultOAuth2DeviceUserCodeProvider
 
DefaultOAuth2DeviceUserCodeProviderFactory - Class in org.keycloak.models
 
DefaultOAuth2DeviceUserCodeProviderFactory() - Constructor for class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
DefaultPasswordPolicyManagerProvider - Class in org.keycloak.policy
 
DefaultPasswordPolicyManagerProvider(KeycloakSession) - Constructor for class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
DefaultPasswordPolicyManagerProviderFactory - Class in org.keycloak.policy
 
DefaultPasswordPolicyManagerProviderFactory() - Constructor for class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
DefaultPolicyEvaluator - Class in org.keycloak.authorization.policy.evaluation
 
DefaultPolicyEvaluator() - 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
 
DefaultRequiredActions.Action - Enum in org.keycloak.models.utils
 
DefaultUserProfile - Class in org.keycloak.userprofile
The default implementation for UserProfile.
DefaultUserProfile(UserProfileMetadata, Attributes, Function<Attributes, UserModel>, UserModel, KeycloakSession) - Constructor for class org.keycloak.userprofile.DefaultUserProfile
 
DefaultValidationContext<T> - Class in org.keycloak.validation
 
DefaultValidationContext(ValidationContext.Event, KeycloakSession, T) - Constructor for class org.keycloak.validation.DefaultValidationContext
 
delegateUpdateBrokeredUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext, IdentityProviderMapper) - Static method in class org.keycloak.broker.provider.IdentityProviderMapperSyncModeDelegate
 
delete(ClientModel) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Removes a ResourceServer instance, with the given client from the persistent storage.
delete(RealmModel, String) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Deletes a permission from the underlying persistence mechanism.
delete(RealmModel, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Deletes a policy from the underlying persistence mechanism.
delete(RealmModel, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Removes a Resource instance, with the given id from the persistent storage.
delete(RealmModel, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Deletes a scope from the underlying persistence mechanism.
DELETE - org.keycloak.events.admin.OperationType
 
DELETE_ACCOUNT - org.keycloak.events.EventType
 
DELETE_ACCOUNT - org.keycloak.models.utils.DefaultRequiredActions.Action
 
DELETE_ACCOUNT - Static variable in interface org.keycloak.models.AccountRoles
 
DELETE_ACCOUNT_ERROR - org.keycloak.events.EventType
 
deleteOTPCredential(KeycloakSession, RealmModel, UserModel, String) - Static method in class org.keycloak.utils.CredentialHelper
 
deleteRoleMapping(RoleModel) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
deleteScopeMapping(RoleModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
deny() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
deny() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Denies the requested permission.
deny() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
DENY - org.keycloak.authorization.Decision.Effect
 
denyIfNoEffect() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
denyIfNoEffect() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Denies the requested permission if a decision was not made yet.
DeploymentStateProvider - Interface in org.keycloak.models
 
DeploymentStateProviderFactory - Interface in org.keycloak.models
 
DeploymentStateSpi - Class in org.keycloak.models
 
DeploymentStateSpi() - Constructor for class org.keycloak.models.DeploymentStateSpi
 
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
 
detail(String, Collection<String>) - Method in class org.keycloak.events.EventBuilder
Add event detail where strings from the input Collection are filtered not to contain null and then joined using :: character.
detail(String, Stream<String>) - Method in class org.keycloak.events.EventBuilder
Add event detail where strings from the input Stream are filtered not to contain null and then joined using :: character.
Details - Interface in org.keycloak.events
 
DeviceActivityManager - Class in org.keycloak.device
 
DeviceActivityManager() - Constructor for class org.keycloak.device.DeviceActivityManager
 
DIFFERENT_FILES - org.keycloak.exportimport.UsersExportStrategy
 
DIFFERENT_USER_AUTHENTICATED - Static variable in interface org.keycloak.events.Errors
 
DigitsPasswordPolicyProvider - Class in org.keycloak.policy
 
DigitsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.DigitsPasswordPolicyProvider
 
DigitsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
DigitsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
DIRECT_GRANT_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
directGrantFlow(RealmModel, boolean) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
DISABLED_BY_PERMANENT_LOCKOUT - Static variable in interface org.keycloak.services.managers.BruteForceProtector
 
DisabledStickySessionEncoderProvider - Class in org.keycloak.sessions
 
DisabledStickySessionEncoderProvider() - Constructor for class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
display(String) - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProvider
 
display(String) - Method in interface org.keycloak.models.OAuth2DeviceUserCodeProvider
Get human-readability user code from original user code.
DISPLAY_NOT_SUPPORTED - org.keycloak.authentication.AuthenticationFlowError
 
DISPLAY_UNSUPPORTED - Static variable in interface org.keycloak.events.Errors
 
distinctByKey(Function<? super T, ?>) - Static method in class org.keycloak.utils.StreamsUtil
distinctByKey is not supposed to be used with parallel streams To make this method synchronized use ConcurrentHashMap<Object, Boolean> instead of HashSet
DOCKER_AUTH - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
dockerAuthenticationFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
doDelete(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doDelete(String, KeycloakSession) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doGet(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doGet(String, KeycloakSession) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doHead(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doPatch(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doPost(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doPost(String, KeycloakSession) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doPut(String, HttpClient) - Static method in class org.keycloak.broker.provider.util.SimpleHttp
 
doubleValidator() - Static method in class org.keycloak.validate.Validators
 
DoubleValidator - Class in org.keycloak.validate.validators
Validate input being any kind of Number.
DoubleValidator() - Constructor for class org.keycloak.validate.validators.DoubleValidator
 
DoubleValidator(ValidatorConfig) - Constructor for class org.keycloak.validate.validators.DoubleValidator
 
doValidate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.AbstractSimpleValidator
Validate type, format, range of the value etc.
doValidate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.AbstractStringValidator
 
doValidate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.AbstractStringValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.EmailValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.LengthValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.LocalDateValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.OptionsValidator
 
doValidate(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.PatternValidator
 

E

EDIT_MODE - Static variable in class org.keycloak.models.LDAPConstants
 
EMAIL - Static variable in interface org.keycloak.events.Details
 
EMAIL - Static variable in class org.keycloak.models.ClaimMask
 
EMAIL - Static variable in class org.keycloak.models.LDAPConstants
 
EMAIL_IN_USE - Static variable in interface org.keycloak.events.Errors
 
EMAIL_SEND_FAILED - Static variable in interface org.keycloak.events.Errors
 
EmailException - Exception in org.keycloak.email
 
EmailException(String) - Constructor for exception org.keycloak.email.EmailException
 
EmailException(String, Throwable) - Constructor for exception org.keycloak.email.EmailException
 
EmailException(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
 
emailValidator() - Static method in class org.keycloak.validate.Validators
 
EmailValidator - Class in org.keycloak.validate.validators
Email format validation - accepts plain string and collection of strings, for basic behavior like null/blank values handling and collections support see AbstractStringValidator.
EmailValidator() - Constructor for class org.keycloak.validate.validators.EmailValidator
 
EMPTY - Static variable in interface org.keycloak.scripting.ScriptBindingsConfigurer
A default ScriptBindingsConfigurer that provides no Bindings.
EMPTY - Static variable in class org.keycloak.validate.ValidatorConfig
An empty ValidatorConfig.
EMPTY_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
EMPTY_FILTER - Static variable in enum org.keycloak.authorization.model.Policy.FilterOption
 
EMPTY_MEMBER_ATTRIBUTE_VALUE - Static variable in class org.keycloak.models.LDAPConstants
 
EMPTY_VALUE - Static variable in interface org.keycloak.userprofile.Attributes
Default value for attributes with no value set.
Enabled(KeycloakSession, Class<?>) - Constructor for class org.keycloak.utils.LockObjectsForModification.Enabled
 
ENABLED - Static variable in class org.keycloak.models.LDAPConstants
 
encode(String) - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
encode(String, int) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
encoded(String, RealmModel) - Static method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
encodedCredential(String, int) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
encodeSessionId(String) - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
encodeSessionId(String) - Method in interface org.keycloak.sessions.StickySessionEncoderProvider
 
Entry(String, Collection<String>) - Constructor for class org.keycloak.authorization.attribute.Attributes.Entry
 
ENTRY_UUID - Static variable in class org.keycloak.models.LDAPConstants
 
EnvironmentDependentProviderFactory - Interface in org.keycloak.provider
Providers that are only supported in some environments can implement this interface to be able to determine if they should be available or not.
EQUAL - Static variable in class org.keycloak.models.LDAPConstants
 
equals(Object) - Method in class org.keycloak.migration.ModelVersion
 
equals(Object) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate.WithId
 
equals(Object) - Method in class org.keycloak.userprofile.AttributeMetadata
 
equals(Object) - Method in class org.keycloak.userprofile.AttributeValidatorMetadata
 
equals(Object) - Method in class org.keycloak.userprofile.UserProfileMetadata
 
equals(Object) - Method in class org.keycloak.validate.ValidationError
 
equals(Object) - Method in class org.keycloak.validation.ValidationError
 
error(String) - Method in interface org.keycloak.authentication.ValidationContext
 
error(String) - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
Called when error happened on the IDP side.
error(String) - Method in class org.keycloak.events.EventBuilder
 
Error(ValidationError) - Constructor for class org.keycloak.userprofile.ValidationException.Error
 
ERROR - org.keycloak.authentication.RequiredActionContext.KcActionStatus
 
ERROR - org.keycloak.forms.login.LoginFormsPages
 
ERROR_MESSAGE - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProvider
 
ERROR_WEBAUTHN - org.keycloak.forms.login.LoginFormsPages
 
errorMessage - Variable in exception org.keycloak.authentication.ForkFlowException
 
Errors - Interface in org.keycloak.events
 
eval(ScriptContext) - Method in interface org.keycloak.scripting.EvaluatableScriptAdapter
 
eval(ScriptBindingsConfigurer) - Method in interface org.keycloak.scripting.EvaluatableScriptAdapter
 
EvaluatableScriptAdapter - Interface in org.keycloak.scripting
Wraps a ScriptModel so it can be evaluated with custom bindings.
evaluate(D) - Method in interface org.keycloak.authorization.permission.evaluator.PermissionEvaluator
 
evaluate(Decision) - Method in class org.keycloak.authorization.permission.evaluator.UnboundedPermissionEvaluator
 
evaluate(ResourceServer, AuthorizationRequest) - Method in interface org.keycloak.authorization.permission.evaluator.PermissionEvaluator
 
evaluate(ResourceServer, AuthorizationRequest) - Method in class org.keycloak.authorization.permission.evaluator.UnboundedPermissionEvaluator
 
evaluate(ResourcePermission, AuthorizationProvider, EvaluationContext, Decision, Map<Policy, Map<Object, Decision.Effect>>) - Method in class org.keycloak.authorization.policy.evaluation.DefaultPolicyEvaluator
 
evaluate(ResourcePermission, AuthorizationProvider, EvaluationContext, Decision, Map<Policy, Map<Object, Decision.Effect>>) - 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 user 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(AuthorizationProvider) - Constructor for class org.keycloak.authorization.permission.evaluator.Evaluators
 
event(EventType) - Method in class org.keycloak.events.EventBuilder
 
Event - Class in org.keycloak.events
 
Event() - Constructor for class org.keycloak.events.Event
 
EVENT_TYPE - Static variable in class org.keycloak.events.Event.SearchableFields
 
Event.SearchableFields - Class in org.keycloak.events
 
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
 
EventListenerTransaction - Class in org.keycloak.events
 
EventListenerTransaction(BiConsumer<AdminEvent, Boolean>, Consumer<Event>) - Constructor for class org.keycloak.events.EventListenerTransaction
 
EventQuery - Interface in org.keycloak.events
 
eventReceived(ClusterEvent) - Method in interface org.keycloak.cluster.ClusterListener
Registered task to be executed on all cluster nodes once it's notified from cache.
EventStoreProvider - Interface in org.keycloak.events
 
EventStoreProviderFactory - Interface in org.keycloak.events
 
EventStoreSpi - Class in org.keycloak.events
 
EventStoreSpi() - Constructor for class org.keycloak.events.EventStoreSpi
 
EventType - Enum in org.keycloak.events
 
EXACT_NAME - org.keycloak.authorization.model.Resource.FilterOption
 
ExceptionConverter - Interface in org.keycloak.provider
Use to unwrap exceptions specifically if there is an exception at JTA commit
ExceptionConverterSpi - Class in org.keycloak.provider
 
ExceptionConverterSpi() - Constructor for class org.keycloak.provider.ExceptionConverterSpi
 
exchange(TokenExchangeContext) - Method in interface org.keycloak.protocol.oidc.TokenExchangeProvider
Exchange the token.
exchangeErrorResponse(UriInfo, ClientModel, UserSessionModel, String, String) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
exchangeExternal(EventBuilder, MultivaluedMap<String, String>) - Method in interface org.keycloak.broker.provider.ExchangeExternalToken
 
exchangeExternalComplete(UserSessionModel, BrokeredIdentityContext, MultivaluedMap<String, String>) - Method in interface org.keycloak.broker.provider.ExchangeExternalToken
 
ExchangeExternalToken - Interface in org.keycloak.broker.provider
Exchange a token crafted by this provider for a local realm token.
exchangeFromToken(UriInfo, EventBuilder, ClientModel, UserSessionModel, UserModel, MultivaluedMap<String, String>) - Method in interface org.keycloak.broker.provider.ExchangeTokenToIdentityProviderToken
 
exchangeNotLinked(UriInfo, ClientModel, UserSessionModel, UserModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
exchangeNotLinkedNoStore(UriInfo, ClientModel, UserSessionModel, UserModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
exchangeNotSupported() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
exchangeTokenExpired(UriInfo, ClientModel, UserSessionModel, UserModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
ExchangeTokenToIdentityProviderToken - Interface in org.keycloak.broker.provider
 
exchangeUnsupportedRequiredType() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
EXCLUDE_SESSION_STATE_FROM_AUTH_RESPONSE - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
excludeOtherErrors() - Method in interface org.keycloak.authentication.ValidationContext
The error messages of this current validation will take precedence over any others.
EXECUTE_ACTION_TOKEN - org.keycloak.events.EventType
 
EXECUTE_ACTION_TOKEN_ERROR - org.keycloak.events.EventType
 
EXECUTE_ACTIONS - org.keycloak.events.EventType
 
EXECUTE_ACTIONS_ERROR - org.keycloak.events.EventType
 
executed(T) - Static method in class org.keycloak.cluster.ExecutionResult
 
executeIfNotExecuted(String, int, Callable<T>) - Method in interface org.keycloak.cluster.ClusterProvider
Deprecated.
Execute given task just if it's not already in progress (either on this or any other cluster node).
executeIfNotExecutedAsync(String, int, Callable) - Method in interface org.keycloak.cluster.ClusterProvider
Deprecated.
Execute given task just if it's not already in progress (either on this or any other cluster node).
executeOnEvent(ClientPolicyContext) - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
execute actions against the client on the event defined in ClientPolicyEvent.
EXECUTION - Static variable in class org.keycloak.models.Constants
 
ExecutionResult<T> - Class in org.keycloak.cluster
 
ExecutorsProvider - Interface in org.keycloak.executors
 
ExecutorsProviderFactory - Interface in org.keycloak.executors
 
ExecutorsSpi - Class in org.keycloak.executors
 
ExecutorsSpi() - Constructor for class org.keycloak.executors.ExecutorsSpi
 
EXISTING_USER - Static variable in interface org.keycloak.events.Details
 
exists(String) - Method in interface org.keycloak.authorization.attribute.Attributes
Checks if there is an attribute with the given name.
EXPIRED_CODE - org.keycloak.authentication.AuthenticationFlowError
 
EXPIRED_CODE - Static variable in interface org.keycloak.events.Errors
 
EXPIRED_OAUTH2_DEVICE_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.
ExportAdapter - Interface in org.keycloak.exportimport
This adapter allows the exporter to act independent of APIs used to serve the exported data to the caller.
ExportAdapter.ConsumerOfOutputStream - Interface in org.keycloak.exportimport
Custom consumer that is allowed to throw an IOException as writing to an output stream might do this.
exportAuthenticationFlows(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
exportGroups(RealmModel, RealmRepresentation) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
ExportImportManager - Interface in org.keycloak.storage
Manage importing and updating of realms for the legacy store.
exportModel(KeycloakSessionFactory) - Method in interface org.keycloak.exportimport.ExportProvider
 
ExportOptions - Class in org.keycloak.exportimport
 
ExportOptions() - Constructor for class org.keycloak.exportimport.ExportOptions
 
ExportOptions(boolean, boolean, boolean, boolean) - Constructor for class org.keycloak.exportimport.ExportOptions
 
ExportProvider - Interface in org.keycloak.exportimport
 
ExportProviderFactory - Interface in org.keycloak.exportimport
 
exportRealm(KeycloakSessionFactory, String) - Method in interface org.keycloak.exportimport.ExportProvider
 
exportRealm(RealmModel, ExportOptions, ExportAdapter) - Method in interface org.keycloak.storage.ExportImportManager
 
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
 
EXTERNAL_IDENTITY_PROVIDER - Static variable in interface org.keycloak.broker.provider.IdentityProvider
 
extractRealm(ClientModel.ClientIdChangeEvent) - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByClientIdSynchronizer
 
extractRealm(GroupModel.GroupPathChangeEvent) - Method in class org.keycloak.broker.provider.mappersync.GroupConfigPropertyByPathSynchronizer
 
extractRealm(RoleModel.RoleNameChangeEvent) - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByRoleNameSynchronizer
 
extractRealm(T) - Method in interface org.keycloak.broker.provider.mappersync.ConfigSynchronizer
 

F

FAILED - org.keycloak.authentication.FlowStatus
Flow will be aborted.
failedLogin(RealmModel, UserModel, ClientConnection) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
failure() - Method in interface org.keycloak.authentication.RequiredActionContext
Abort the authentication with an error
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(AuthenticationFlowError, Response, String, String) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Aborts the current flow.
FAILURE - org.keycloak.authentication.RequiredActionContext.Status
 
FAILURE_CHALLENGE - org.keycloak.authentication.FlowStatus
Flow will be aborted and a Response provided by the execution will be sent.
failureChallenge(AuthenticationFlowError, Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Same behavior as forceChallenge(), but the error count in brute force attack detection will be incremented.
FEDERATED_ACCESS_TOKEN - Static variable in interface org.keycloak.broker.provider.IdentityProvider
 
FEDERATED_IDENTITY - org.keycloak.forms.account.AccountPages
 
FEDERATED_IDENTITY_EXISTS - Static variable in interface org.keycloak.events.Errors
 
FEDERATED_IDENTITY_LINK - org.keycloak.events.EventType
 
FEDERATED_IDENTITY_LINK_ERROR - org.keycloak.events.EventType
 
fieldHasError(String) - Method in class org.keycloak.validation.ValidationResult
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
fieldMatches(Field) - Method in class org.keycloak.models.utils.reflection.TypedPropertyCriteria
 
FileBasedPasswordBlacklist(Path, String) - Constructor for class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist
 
fillInStackTrace() - Method in error org.keycloak.ServerStartupError
 
filterValidRepresentations(Stream<M>, Function<M, R>) - Static method in class org.keycloak.models.utils.ModelToRepresentation
Handles exceptions that occur when transforming the model to a representation and will remove all null objects from the stream.
find(RealmModel, ResourceServer, Map<PermissionTicket.FilterOption, String>, Integer, Integer) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of PermissionTicket, filtered by the given attributes.
find(RealmModel, ResourceServer, Map<Policy.FilterOption, String[]>, Integer, Integer) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a ResourceServer with the given resourceServerId.
find(RealmModel, ResourceServer, Map<Resource.FilterOption, String[]>, Integer, Integer) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances associated with a given resource server.
findByAlias(String) - Static method in enum org.keycloak.models.utils.DefaultRequiredActions.Action
 
findByClient(ClientModel) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Returns a ResourceServer instance based on a client.
findById(RealmModel, String) - Method in interface org.keycloak.authorization.store.ResourceServerStore
Returns a ResourceServer instance based on its identifier.
findById(RealmModel, ResourceServer, String) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a PermissionTicket with the given id
findById(RealmModel, ResourceServer, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a Policy with the given id
findById(RealmModel, ResourceServer, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Returns a Resource instance based on its identifier.
findById(RealmModel, ResourceServer, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a Scope with the given id
findByName(ResourceServer, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a Policy with the given name
findByName(ResourceServer, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Find a Resource by its name where the owner is the resource server itself.
findByName(ResourceServer, String) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a Scope with the given name
findByName(ResourceServer, String, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Find a Resource by its name where the owner is the given ownerId.
findByOwner(RealmModel, ResourceServer, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances with the given ownerId.
findByOwner(RealmModel, ResourceServer, String, Consumer<Resource>) - Method in interface org.keycloak.authorization.store.ResourceStore
 
findByResource(ResourceServer, Resource) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of PermissionTicket associated with the resource.
findByResource(ResourceServer, Resource) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a Resource
findByResource(ResourceServer, Resource, Consumer<Policy>) - Method in interface org.keycloak.authorization.store.PolicyStore
Searches for all policies associated with the Resource and passes the result to the consumer
findByResourceServer(ResourceServer) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with the ResourceServer
findByResourceServer(ResourceServer) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource instances associated with a given resource server.
findByResourceServer(ResourceServer) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a list of Scope associated with the ResourceServer.
findByResourceServer(ResourceServer, Map<Scope.FilterOption, String[]>, Integer, Integer) - Method in interface org.keycloak.authorization.store.ScopeStore
Returns a list of Scope associated with a ResourceServer with the given resourceServerId.
findByResourceType(ResourceServer, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a ResourceServer with the given type.
findByResourceType(ResourceServer, String, Consumer<Policy>) - Method in interface org.keycloak.authorization.store.PolicyStore
Searches for policies associated with a ResourceServer and passes the result to the consumer
findByScope(ResourceServer, Scope) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of PermissionTicket associated with the scope.
findByScopes(ResourceServer, List<Scope>) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a Scope within the given scope.
findByScopes(ResourceServer, Set<Scope>) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource associated with a given scope.
findByScopes(ResourceServer, Set<Scope>, Consumer<Resource>) - Method in interface org.keycloak.authorization.store.ResourceStore
 
findByScopes(ResourceServer, Resource, List<Scope>) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy associated with a Scope with the given resource and scopes.
findByScopes(ResourceServer, Resource, List<Scope>, Consumer<Policy>) - Method in interface org.keycloak.authorization.store.PolicyStore
Effectively the same method as PolicyStore.findByScopes(ResourceServer, Resource, List), however in the end the consumer is fed with the result.
findByType(ResourceServer, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy with the given type.
findByType(ResourceServer, String) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource from ResourceServer with the given type.
findByType(ResourceServer, String, String, Consumer<Resource>) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource with the given type.
findByType(ResourceServer, String, Consumer<Resource>) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource from ResourceServer with the given type.
findByTypeInstance(ResourceServer, String, Consumer<Resource>) - Method in interface org.keycloak.authorization.store.ResourceStore
Finds all Resource by type where client represented by the resourceServer is not the owner
findClientScopeById(RealmModel, ClientModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Lookup clientScope OR client by id.
findDependentPolicies(ResourceServer, String) - Method in interface org.keycloak.authorization.store.PolicyStore
Returns a list of Policy that depends on another policy with the given id.
findGranted(ResourceServer, String) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of PermissionTicket granted to the given userId.
findGranted(ResourceServer, String, String) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of PermissionTicket with name equal to resourceName granted to the given userId.
findGrantedOwnerResources(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of Resource granted by the owner to other users
findGrantedResources(RealmModel, String, String, Integer, Integer) - Method in interface org.keycloak.authorization.store.PermissionTicketStore
Returns a list of Resource granted to the given requester
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 for authentication
finishBrowserLogout(UserSessionModel, AuthenticationSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
This method is called when browser logout is going to be finished.
fire(KeycloakSession, RealmModel, boolean) - Static method in class org.keycloak.storage.LegacyStoreSyncEvent
 
fire(KeycloakSession, RealmModel, RealmRepresentation, boolean) - Static method in class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
fire(KeycloakSession, RealmRepresentation) - Static method in class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
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.events.Details
 
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
Index of the first result to return.
FLOW_RESET - org.keycloak.authentication.FlowStatus
This flow was reset to the beginning.
FlowStatus - Enum in org.keycloak.authentication
Status of an execution/authenticator in a Authentication Flow
FORCE_CHALLENGE - org.keycloak.authentication.FlowStatus
Irregardless of the execution's requirement, this challenge will be sent to the user.
FORCE_LEVEL_OF_AUTHENTICATION - Static variable in class org.keycloak.models.Constants
 
forceChallenge(Response) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Sends the challenge back to the HTTP client irregardless of the current executionr requirement
ForceExpiredPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
ForceExpiredPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
forEachError(Consumer<ValidationError>) - Method in class org.keycloak.validate.ValidationResult
Convenience method that accepts a Consumer.
fork() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Fork the current flow.
FORK - org.keycloak.authentication.FlowStatus
This flow is being forked.
FORK_FLOW - org.keycloak.authentication.AuthenticationFlowError
 
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
 
format(String) - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProvider
 
format(String) - Method in interface org.keycloak.models.OAuth2DeviceUserCodeProvider
Format inputted user code.
formatMessage(BiFunction<String, Object[], String>) - Method in class org.keycloak.validate.ValidationError
Formats the current ValidationError with the given formatter Function.
FormAuthenticator - Interface in org.keycloak.authentication
This class is responsible for rendering a form.
FormAuthenticatorFactory - Interface in org.keycloak.authentication
Factory for instantiating FormAuthenticators.
FormAuthenticatorSpi - Class in org.keycloak.authentication
 
FormAuthenticatorSpi() - Constructor for class org.keycloak.authentication.FormAuthenticatorSpi
 
FormContext - Interface in org.keycloak.authentication
Interface that encapsulates the current state of the current form being executed
FormMessage - Class in org.keycloak.models.utils
Message (eg.
FormMessage() - Constructor for class org.keycloak.models.utils.FormMessage
 
FormMessage(String, Object...) - Constructor for class org.keycloak.models.utils.FormMessage
 
FormMessage(String, String) - Constructor for class org.keycloak.models.utils.FormMessage
Create message without parameters.
FormMessage(String, String, Object...) - Constructor for class org.keycloak.models.utils.FormMessage
Create message.
frameAncestors(String) - Method in class org.keycloak.models.ContentSecurityPolicyBuilder
 
frameSrc(String) - Method in class org.keycloak.models.ContentSecurityPolicyBuilder
 
from(Collection<ResourcePermission>, EvaluationContext) - Method in class org.keycloak.authorization.permission.evaluator.Evaluators
 
from(Map<String, Collection<String>>) - Static method in interface org.keycloak.authorization.attribute.Attributes
 
from(EvaluationContext, ResourceServer, AuthorizationRequest) - Method in class org.keycloak.authorization.permission.evaluator.Evaluators
 
from(ValidationContext) - Static method in class org.keycloak.userprofile.UserProfileAttributeValidationContext
Easy way to cast me from ValidationContext in Validator implementation
fromCache(RealmModel, String, Map<String, String>) - Static method in class org.keycloak.models.OAuth2DeviceCodeModel
 
fromCache(RealmModel, String, Map<String, String>) - Static method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
fromDate(Date) - Method in interface org.keycloak.events.EventQuery
Search events that are newer than fromDate
fromTime(Date) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by events after the specified time
FRONT_CHANNEL_LOGOUT_SESSION_REQUIRED - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
FRONT_CHANNEL_LOGOUT_URI - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
FRONTCHANNEL_LOGOUT - org.keycloak.forms.login.LoginFormsPages
 
frontchannelLogout(UserSessionModel, AuthenticatedClientSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 

G

GENDER - Static variable in class org.keycloak.models.ClaimMask
 
generate() - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProvider
 
generate() - Method in interface org.keycloak.models.OAuth2DeviceUserCodeProvider
Generate a new user code for OAuth 2.0 Device Authorization Grant.
GENERATE - Static variable in class org.keycloak.models.Constants
 
generateAccessCode() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
generateCode() - Method in interface org.keycloak.authentication.RequiredActionContext
Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
generateCodeSecret() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateId() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateInstallation(KeycloakSession, RealmModel, ClientModel, URI) - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
generateKeyPairCertificate(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateSecret(ClientModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
generateTOTP(String) - Method in class org.keycloak.models.utils.TimeBasedOTP
Generates a token.
GENERIC_AUTHENTICATION_ERROR - org.keycloak.authentication.AuthenticationFlowError
 
GENERIC_AUTHENTICATION_ERROR - Static variable in interface org.keycloak.events.Errors
 
get(String) - Method in class org.keycloak.component.ComponentModelScope
 
get(String) - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
Helper method
get(String) - Method in interface org.keycloak.models.SingleUseObjectProvider
Gets data associated with the given key.
get(String) - Method in class org.keycloak.validate.ValidatorConfig
 
get(String, String) - Method in class org.keycloak.component.ComponentModelScope
 
getActionTokenUrl(String) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Get the action URL for the action token executor.
getActionUrl() - Method in interface org.keycloak.authentication.RequiredActionContext
Get the action URL for the required action.
getActionUrl(String) - 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.
getActorToken() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getActorTokenType() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getAdapterConfiguration(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client.
getAdditionalParams() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getAdminResource(ResourceServer, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getAfeList() - Method in exception org.keycloak.authentication.AuthenticationFlowException
 
getAlias() - Method in enum org.keycloak.models.utils.DefaultRequiredActions.Action
 
getAllErrorsAsString() - Method in class org.keycloak.validation.ValidationResult
 
getAllErrorsAsString(Function<ValidationError, String>) - Method in class org.keycloak.validation.ValidationResult
 
getAllLocalizedErrorsAsString(Properties) - Method in class org.keycloak.validation.ValidationResult
 
getAndVerifyAuthenticationSession(String) - Method in interface org.keycloak.broker.provider.IdentityProvider.AuthenticationCallback
Common method to return current authenticationSession and verify if it is not expired
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
getAnnotations() - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
getAnnotations() - Method in class org.keycloak.userprofile.AttributeMetadata
 
getArray(String) - Method in class org.keycloak.component.ComponentModelScope
 
getArtifactBindingIdentifierString(byte[]) - Static method in class org.keycloak.protocol.saml.util.ArtifactBindingUtils
Turns byte representation of the identifier into readable String
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() - Method in class org.keycloak.userprofile.AttributeContext
 
getAttribute() - Method in class org.keycloak.userprofile.ValidationException.Error
 
getAttribute(String) - Method in interface org.keycloak.authorization.model.Resource
Returns the values of an attribute with the given name
getAttribute(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getAttribute(String) - Method in class org.keycloak.userprofile.UserProfileMetadata
Get existing AttributeMetadata for attribute of given name.
getAttributeContext() - Method in class org.keycloak.userprofile.UserProfileAttributeValidationContext
 
getAttributeDisplayName() - Method in class org.keycloak.userprofile.AttributeMetadata
 
getAttributeGroupMetadata() - Method in class org.keycloak.userprofile.AttributeMetadata
 
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.model.Resource
Returns the attributes associated with this resource.
getAttributes() - Method in interface org.keycloak.authorization.policy.evaluation.EvaluationContext
Returns all attributes within the current execution and runtime environment.
getAttributes() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getAttributes() - Method in class org.keycloak.userprofile.DefaultUserProfile
 
getAttributes() - Method in interface org.keycloak.userprofile.UserProfile
Returns the attributes associated with this instance.
getAttributes() - Method in class org.keycloak.userprofile.UserProfileAttributeValidationContext
 
getAttributes() - Method in class org.keycloak.userprofile.UserProfileMetadata
 
getAttributes() - Method in class org.keycloak.validate.ValidationContext
 
getAudience() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getAuthDetails() - Method in class org.keycloak.events.admin.AdminEvent
Returns authentication details
getAuthenticationExecution() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
getAuthenticationFlowBindingOverride(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getAuthenticationFlowBindingOverrides() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getAuthenticationSelections() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
 
getAuthenticationSession() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
AuthenticationSessionModel attached to this flow
getAuthenticationSession() - Method in interface org.keycloak.authentication.FormContext
AuthenticationSessionModel attached to this flow
getAuthenticationSession() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getAuthenticationSession() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getAuthenticationSession() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
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
getAuthExecId() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
getAuthorizationProvider() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getAuthorizationProvider() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
 
getAuthReqId() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getAuthSessionExpiration(RealmModel, int) - Static method in class org.keycloak.models.utils.SessionExpiration
 
getAuthSessionLifespan(RealmModel) - Static method in class org.keycloak.models.utils.SessionExpiration
 
getBaseType() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property type
getBaseUrl() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getBoolean(String) - Method in class org.keycloak.component.ComponentModelScope
 
getBoolean(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getBoolean(String, Boolean) - Method in class org.keycloak.component.ComponentModelScope
 
getBooleanOrDefault(String, Boolean) - Method in class org.keycloak.validate.ValidatorConfig
 
getBrokerSessionId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getBrokerUserId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getBuiltinMappers() - Method in interface org.keycloak.protocol.LoginProtocolFactory
List of built in protocol mappers that can be used to apply to clients.
getBuiltinMappers(String) - Method in interface org.keycloak.migration.MigrationProvider
 
getCacheManager(Config.Scope) - Method in interface org.keycloak.cluster.ManagedCacheManagerProvider
 
getCacheTimestamp() - Method in interface org.keycloak.authorization.model.CachedModel
When was the model was loaded from database.
getCategoryRequirementFromCurrentFlow(String) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getCertificate(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getChallenge() - Method in interface org.keycloak.authentication.RequiredActionContext
If challenge has been sent this returns the JAX-RS Response
getClaims() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns all permission claims.
getClient() - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Current client attached to this flow.
getClient() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
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.
getClientAuthAttributes() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getClientAuthenticatorType() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getClientConnection() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getClientId() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns id of a client that this ResourceServer is associated with
getClientId() - Method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
getClientId() - Method in class org.keycloak.events.admin.AuthDetails
 
getClientId() - Method in class org.keycloak.events.admin.AuthQuery
 
getClientId() - Method in class org.keycloak.events.Event
 
getClientId() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getClientId() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getClientModelCacheKey(String, String) - Static method in class org.keycloak.keys.PublicKeyStorageUtils
 
getClientModelCacheKey(String, String, JWK.Use) - Static method in class org.keycloak.keys.PublicKeyStorageUtils
 
getClientNotificationToken() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getClientScopeByName(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getClientScopeMappings(ClientModel, ScopeContainerModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Deprecated.
getClientScopeMappingsStream(ClientModel, ScopeContainerModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getClientScopes(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getClusterStartupTime() - Method in interface org.keycloak.cluster.ClusterProvider
Deprecated.
Same value for all cluster nodes.
getCode() - Method in class org.keycloak.scripting.Script
 
getCodeChallenge() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getCodeChallengeMethod() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getCommonProviderConfigProperties() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
configuration properties that are common across all RoleStorageProvider implementations
getCompatibleProviders() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getComponentConfigProperties(KeycloakSession, String, String) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentConfigProperties(KeycloakSession, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentConfigProperties(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentFactory(KeycloakSessionFactory, Class<T>, Config.Scope, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getComponentFactory(KeycloakSession, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentFactory(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.ComponentUtil
 
getComponentId() - Method in class org.keycloak.component.ComponentModelScope
 
getComponentModel() - Method in class org.keycloak.component.ComponentModelScope
 
getComponentModel(KeycloakSessionFactory, String, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getComponentName() - Method in class org.keycloak.component.ComponentModelScope
 
getComponentNote(String) - Method in class org.keycloak.component.ComponentModelScope
 
getComponentParentId() - Method in class org.keycloak.component.ComponentModelScope
 
getComponentSubType() - Method in class org.keycloak.component.ComponentModelScope
 
getConditionConfigurationClass() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
 
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
 
getConfigProperties() - Method in interface org.keycloak.component.AmphibianProviderFactory
 
getConfigProperties() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
getConfigProperties() - Method in class org.keycloak.validate.validators.AbstractNumberValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.EmailValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.LengthValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.LocalDateValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.OptionsValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.PatternValidator
 
getConfigProperties() - Method in class org.keycloak.validate.validators.UriValidator
 
getConfigPropertiesPerClient() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
List of config properties for this client implementation.
getConfigPropertyName() - Method in class org.keycloak.broker.provider.mappersync.AbstractConfigPropertySynchronizer
 
getConfigPropertyName() - Method in class org.keycloak.broker.provider.mappersync.GroupConfigPropertyByPathSynchronizer
 
getConfigPropertyName() - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByClientIdSynchronizer
 
getConfigPropertyName() - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByRoleNameSynchronizer
 
getConfigType() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getConfigType() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getConfigType() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getConfigurableAuthenticatorFactory(KeycloakSession, String) - Static method in class org.keycloak.utils.CredentialHelper
 
getConfiguration() - Method in interface org.keycloak.userprofile.UserProfileProvider
Get current UserProfile configuration.
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
 
getConsentScreenText() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getContext() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getContext() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns the EvaluationContext.
getContext() - Method in class org.keycloak.userprofile.AttributeContext
 
getContext() - Method in class org.keycloak.userprofile.UserProfileMetadata
 
getContextData() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getCors() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getCreatedTimestamp() - Method in interface org.keycloak.authorization.model.PermissionTicket
 
getCredentialProvider(KeycloakSession) - Method in interface org.keycloak.authentication.CredentialValidator
 
getCredentials(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.CredentialValidator
 
getCurrentDevice(UserSessionModel) - Static method in class org.keycloak.device.DeviceActivityManager
Returns the device information associated with the given userSession.
getCurrentLock() - Method in interface org.keycloak.models.dblock.DBLockProvider
Returns the current provider namespace locked or null
getDBLock() - Method in class org.keycloak.models.dblock.DBLockManager
 
getDBLockFactory() - Method in class org.keycloak.models.dblock.DBLockManager
 
getDecisionCache() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getDecisionStrategy() - Method in interface org.keycloak.authorization.model.Policy
Returns the DecisionStrategy for this policy.
getDecisionStrategy() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the DecisionStrategy configured for this instance.
getDeclaringClass() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the class that declares the property
getDecodedState() - Method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
getDefaultBlacklistsBasePath() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
Method to obtain the default location for the list folder.
getDefaultClientAuthenticatorType() - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getDefaultConfigValue() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getDefaultConfigValue() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getDefaultRolesStream() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getDefaultValue() - Method in enum org.keycloak.models.BrowserSecurityHeaders
 
getDelegateForUpdate() - Method in interface org.keycloak.authorization.model.CachedModel
Invalidates the cache for this model and returns a delegate that represents the actual data provider
getDescription() - Method in interface org.keycloak.authorization.model.Policy
Returns the description of this policy.
getDescription() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getDescription() - Method in class org.keycloak.scripting.Script
 
getDetails() - Method in class org.keycloak.events.Event
 
getDeviceCode() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getDeviceCode() - Method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
getDisplayCategory() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getDisplayCategory() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getDisplayDescription() - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
getDisplayHeader() - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
getDisplayName() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
getDisplayName() - Method in interface org.keycloak.authorization.model.Resource
Returns the end user friendly name for this resource.
getDisplayName() - Method in interface org.keycloak.authorization.model.Scope
Returns the end user friendly name for this scope.
getDisplayName() - Method in enum org.keycloak.models.ImpersonationSessionNote
 
getDisplayName() - Method in interface org.keycloak.models.UserSessionNoteDescriptor
 
getDisplayName() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getDisplayName() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getDisplayName() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getDisplayText() - Method in interface org.keycloak.authentication.RequiredActionFactory
Display text used in admin console to reference this required action
getDisplayType() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
Friendly name for the authenticator
getDisplayType() - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
getDisplayType() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getDisplayType() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getDouble(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getDoubleOrDefault(String, Double) - Method in class org.keycloak.validate.ValidatorConfig
 
getDynamicClientScope(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getDynamicScopeRegexp() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getEffect() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getEffect() - Method in class org.keycloak.authorization.policy.evaluation.Result
 
getEffect() - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
getEmail() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getEncoded() - Method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
getEncodedOCSPResponse(KeycloakSession, byte[], URI) - Method in class org.keycloak.utils.OCSPProvider
 
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
 
getErrors() - Method in exception org.keycloak.userprofile.ValidationException
 
getErrors() - Method in class org.keycloak.validate.ValidationContext
 
getErrors() - Method in class org.keycloak.validate.ValidationResult
 
getErrors() - Method in class org.keycloak.validation.ValidationResult
 
getErrorsForInputHint(String) - Method in class org.keycloak.validate.ValidationResult
Returns a Set of ValidationError's with the given inputHint if present, otherwise an empty Set is returned.
getErrorsForValidatorId(String) - Method in class org.keycloak.validate.ValidationResult
Returns a Set of ValidationError's from the Validator with the given id if present, otherwise an empty Set is returned.
getEvaluation() - Method in class org.keycloak.authorization.policy.evaluation.Result
 
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
 
getEvent() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getEvent() - Method in class org.keycloak.validation.DefaultValidationContext
 
getEvent() - Method in interface org.keycloak.validation.ValidationContext
 
getEventClass() - Method in interface org.keycloak.broker.provider.mappersync.ConfigSynchronizer
 
getEventClass() - Method in class org.keycloak.broker.provider.mappersync.GroupConfigPropertyByPathSynchronizer
 
getEventClass() - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByClientIdSynchronizer
 
getEventClass() - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByRoleNameSynchronizer
 
getEventDetails() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Get details of the event that caused an error
getEventDetails() - Method in exception org.keycloak.authentication.AuthenticationFlowException
 
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
getExecutor(String) - Method in interface org.keycloak.executors.ExecutorsProvider
Impl will usually return different executors for different tasks.
getExecutorConfigurationClass() - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
 
getExpiration() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getExportImportManager() - Method in interface org.keycloak.storage.DatastoreProvider
 
getFactory() - Method in class org.keycloak.models.utils.PostMigrationEvent
 
getField() - Method in class org.keycloak.models.utils.FormMessage
 
getFieldId() - Method in class org.keycloak.validation.ValidationError
 
getFilename() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getFirstHeader(String) - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
getFirstName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getFirstPublicKey(String, String, PublicKeyLoader) - Method in interface org.keycloak.keys.PublicKeyStorageProvider
Get first found public key to verify messages signed by particular client having several public keys.
getFirstResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get the first result from the query, causing the query to be run.
getFirstValue(String) - Method in interface org.keycloak.userprofile.Attributes
Returns the first value associated with the attribute with the given .
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.
getFlowExceptions() - Method in interface org.keycloak.authentication.AuthenticationFlow
 
getFlowPath() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
 
getFormattedMessage(BiFunction<String, Object[], String>) - Method in class org.keycloak.userprofile.ValidationException.Error
 
getFormParams() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
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.
getForwardedInfoMessage() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
This could be an info message forwarded from another authenticator.
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.
getGrantedTimestamp() - Method in interface org.keycloak.authorization.model.PermissionTicket
 
getGroup() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getGuiOrder() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getGuiOrder() - Method in class org.keycloak.userprofile.AttributeMetadata
 
getHeader(String) - Method in class org.keycloak.broker.provider.util.SimpleHttp.Response
 
getHeaderName() - Method in enum org.keycloak.models.BrowserSecurityHeaders
 
getHeaders() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getHelpText() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
getHelpText() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getHelpText() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
getHelpText() - Method in class org.keycloak.validate.validators.DoubleValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.EmailValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.IntegerValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.LengthValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.LocalDateValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.OptionsValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.PatternValidator
 
getHelpText() - Method in class org.keycloak.validate.validators.UriValidator
 
getHttpClient() - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
Returns the CloseableHttpClient that can be freely used.
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
 
getIconCssClass() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
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.PermissionTicket
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.Policy
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.Resource
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the unique identifier for this instance.
getId() - Method in interface org.keycloak.authorization.model.Scope
Returns the unique identifier for this instance.
getId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getId() - Method in interface org.keycloak.credential.CredentialProviderFactory
This is the name of the provider and will be showed in the admin console as an option.
getId() - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
getId() - Method in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
getId() - Method in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
getId() - Method in class org.keycloak.events.admin.AdminEvent
Returns the UUID of the event.
getId() - Method in class org.keycloak.events.Event
 
getId() - Method in enum org.keycloak.models.dblock.DBLockProvider.Namespace
 
getId() - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
getId() - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
getId() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getId() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate.WithId
 
getId() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
getId() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
getId() - Method in class org.keycloak.scripting.Script
 
getId() - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
getId() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
This is the name of the provider.
getId() - Method in class org.keycloak.validate.validators.DoubleValidator
 
getId() - Method in class org.keycloak.validate.validators.EmailValidator
 
getId() - Method in class org.keycloak.validate.validators.IntegerValidator
 
getId() - Method in class org.keycloak.validate.validators.LengthValidator
 
getId() - Method in class org.keycloak.validate.validators.LocalDateValidator
 
getId() - Method in class org.keycloak.validate.validators.NotBlankValidator
 
getId() - Method in class org.keycloak.validate.validators.NotEmptyValidator
 
getId() - Method in class org.keycloak.validate.validators.OptionsValidator
 
getId() - Method in class org.keycloak.validate.validators.PatternValidator
 
getId() - Method in class org.keycloak.validate.validators.UriValidator
 
getId() - Method in class org.keycloak.validate.validators.ValidatorConfigValidator
 
getIdentity() - Method in interface org.keycloak.authorization.policy.evaluation.EvaluationContext
Returns the Identity that represents an entity (person or non-person) to which the permissions must be granted, or not.
getIdentityProviderDisplayName(KeycloakSession, IdentityProviderModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getIdp() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getIdpConfig() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getIdpModelCacheKey(String, String) - Static method in class org.keycloak.keys.PublicKeyStorageUtils
 
getInputHint() - Method in class org.keycloak.validate.ValidationError
 
getInputHintWithMessageParameters() - Method in class org.keycloak.validate.ValidationError
Returns an array where the first element is the ValidationError.inputHint follwed by the ValidationError.messageParameters.
getInt(String) - Method in class org.keycloak.component.ComponentModelScope
 
getInt(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getInt(String, Integer) - Method in class org.keycloak.component.ComponentModelScope
 
getInterface(Class<T>) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
getInterface(Object, Class<T>) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
getIntermediateCertificates() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getInternalValidatorById(String) - Static method in class org.keycloak.validate.Validators
 
getInternalValidatorFactoryById(String) - Static method in class org.keycloak.validate.Validators
 
getInternalValidators() - Static method in class org.keycloak.validate.Validators
 
getIntervalMillis() - Method in interface org.keycloak.timer.TimerProvider.TimerTaskContext
 
getIntOrDefault(String, Integer) - Method in class org.keycloak.validate.ValidatorConfig
 
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
 
getJavaClass() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property type
getJsonValue(JsonNode, String) - Static method in class org.keycloak.utils.JsonUtils
Returns the value corresponding to the given claim.
getKey() - Method in enum org.keycloak.models.BrowserSecurityHeaders
 
getKeycloakSession() - Method in class org.keycloak.authorization.AuthorizationProvider
 
getKeysStream() - Method in interface org.keycloak.keys.KeyProvider
Returns the KeyWrapper for a KeyProvider.
getLastName() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getLegacyId() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
ID from older API version.
getLinkingUrl(UriInfo, ClientModel, UserSessionModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
getLocalizedMessage(Properties) - Method in class org.keycloak.validation.ValidationError
 
getLocalizedMessageKey() - Method in class org.keycloak.validation.ValidationError
 
getLocalizedMessageParams() - Method in class org.keycloak.validation.ValidationError
 
getLocalStoreFactory() - Method in class org.keycloak.authorization.AuthorizationProvider
No cache sits in front of this
getLogic() - Method in interface org.keycloak.authorization.model.Policy
Returns the Logic for this policy.
getLong(String) - Method in class org.keycloak.component.ComponentModelScope
 
getLong(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getLong(String, Long) - Method in class org.keycloak.component.ComponentModelScope
 
getLongOrDefault(String, Long) - Method in class org.keycloak.validate.ValidatorConfig
 
getMajor() - Method in class org.keycloak.migration.ModelVersion
 
getManagementUrl() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getMappersForClaimMask(Long) - Method in interface org.keycloak.migration.MigrationProvider
 
getMarshaller() - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
getMarshaller() - Method in interface org.keycloak.broker.provider.IdentityProvider
Implementation of marshaller to serialize/deserialize attached data to Strings, which can be saved in clientSession
getMasterRealmAdminApplicationClientId(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getMaxAuthAge() - Method in interface org.keycloak.authentication.RequiredActionProvider
Defines the max time after a user login, after which re-authentication is requested for an AIA.
getMediaType() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getMember() - Method in interface org.keycloak.models.utils.reflection.Property
Get the member responsible for retrieving the property value
getMessage() - Method in class org.keycloak.models.utils.FormMessage
 
getMessage() - Method in class org.keycloak.userprofile.ValidationException.Error
 
getMessage() - Method in exception org.keycloak.userprofile.ValidationException
 
getMessage() - Method in class org.keycloak.validate.ValidationError
 
getMessage() - Method in class org.keycloak.validation.ValidationError
 
getMessage(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
getMessageDigest() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
getMessageKey() - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
getMessageParameters() - Method in class org.keycloak.userprofile.ValidationException.Error
 
getMessageParameters() - Method in class org.keycloak.validate.ValidationError
Returns the raw message parameters, e.g.
getMetadata() - Method in class org.keycloak.userprofile.AttributeContext
 
getMetadata(String) - Method in interface org.keycloak.userprofile.Attributes
Returns the metadata associated with the attribute with the given name.
getMetadata(String) - Method in class org.keycloak.userprofile.DefaultAttributes
 
getMicro() - Method in class org.keycloak.migration.ModelVersion
 
getMigrationModel() - Method in interface org.keycloak.models.DeploymentStateProvider
 
getMimeType() - Method in class org.keycloak.scripting.Script
 
getMinMaxConfig(ValidatorConfig, String) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
Get config value for min and max validation bound as a Number supported by this validator
getMinMaxConfig(ValidatorConfig, String) - Method in class org.keycloak.validate.validators.DoubleValidator
 
getMinMaxConfig(ValidatorConfig, String) - Method in class org.keycloak.validate.validators.IntegerValidator
 
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 interface org.keycloak.authentication.otp.OTPApplicationProvider
 
getName() - Method in class org.keycloak.authentication.otp.OTPApplicationSpi
 
getName() - Method in class org.keycloak.authentication.RequiredActionSpi
 
getName() - Method in class org.keycloak.authorization.AuthorizationSpi
 
getName() - Method in enum org.keycloak.authorization.model.PermissionTicket.FilterOption
 
getName() - Method in enum org.keycloak.authorization.model.Policy.FilterOption
 
getName() - Method in interface org.keycloak.authorization.model.Policy
Returns the name of this policy.
getName() - Method in enum org.keycloak.authorization.model.Resource.FilterOption
 
getName() - Method in interface org.keycloak.authorization.model.Resource
Returns the resource's name.
getName() - Method in enum org.keycloak.authorization.model.Scope.FilterOption
 
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.component.ComponentFactorySpi
 
getName() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getName() - Method in class org.keycloak.credential.CredentialSpi
 
getName() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getName() - Method in class org.keycloak.crypto.CekManagementSpi
 
getName() - Method in class org.keycloak.crypto.ClientSignatureVerifierSpi
 
getName() - Method in class org.keycloak.crypto.ContentEncryptionSpi
 
getName() - Method in class org.keycloak.crypto.HashSpi
 
getName() - Method in class org.keycloak.crypto.SignatureSpi
 
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.executors.ExecutorsSpi
 
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.headers.SecurityHeadersSpi
 
getName() - Method in class org.keycloak.keys.KeySpi
 
getName() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
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.ClientScopeSpi
 
getName() - Method in class org.keycloak.models.ClientSpi
 
getName() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getName() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getName() - Method in class org.keycloak.models.DeploymentStateSpi
 
getName() - Method in class org.keycloak.models.GroupSpi
 
getName() - Method in class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
getName() - Method in class org.keycloak.models.RealmSpi
 
getName() - Method in class org.keycloak.models.RoleSpi
 
getName() - Method in class org.keycloak.models.SingleUseObjectSpi
 
getName() - Method in class org.keycloak.models.UserLoginFailureSpi
 
getName() - Method in class org.keycloak.models.UserSessionSpi
 
getName() - Method in class org.keycloak.models.UserSpi
 
getName() - Method in interface org.keycloak.models.utils.reflection.Property
Returns the name of the property.
getName() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist
 
getName() - Method in interface org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.PasswordBlacklist
 
getName() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getName() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getName() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getName() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getName() - Method in class org.keycloak.protocol.oidc.TokenExchangeSpi
 
getName() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getName() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getName() - Method in class org.keycloak.protocol.saml.ArtifactResolverSpi
 
getName() - Method in class org.keycloak.provider.ExceptionConverterSpi
 
getName() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
getName() - Method in class org.keycloak.scripting.Script
 
getName() - Method in class org.keycloak.scripting.ScriptingSpi
 
getName() - Method in class org.keycloak.services.clientpolicy.ClientPolicyManagerSpi
 
getName() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
 
getName() - Method in class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
getName() - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
 
getName() - Method in class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
getName() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getName() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getName() - Method in class org.keycloak.sessions.AuthenticationSessionSpi
 
getName() - Method in class org.keycloak.sessions.StickySessionEncoderSpi
 
getName() - Method in class org.keycloak.storage.DatastoreSpi
 
getName() - Method in class org.keycloak.storage.role.RoleStorageProviderSpi
 
getName() - Method in class org.keycloak.theme.ThemeSpi
 
getName() - Method in class org.keycloak.timer.TimerSpi
 
getName() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getName() - Method in class org.keycloak.truststore.TruststoreSpi
 
getName() - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
getName() - Method in class org.keycloak.userprofile.AttributeMetadata
 
getName() - Method in class org.keycloak.userprofile.UserProfileSpi
 
getName() - Method in class org.keycloak.validate.ValidatorSPI
 
getName() - Method in class org.keycloak.validation.ClientValidationSPI
 
getNodeReRegistrationTimeout() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getNonce() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getNotBefore() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getObjectToValidate() - Method in class org.keycloak.validation.DefaultValidationContext
 
getObjectToValidate() - Method in interface org.keycloak.validation.ValidationContext
 
getOIDCClient() - Method in class org.keycloak.validation.ClientValidationContext.OIDCContext
 
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
getOrDefault(String, Object) - Method in class org.keycloak.validate.ValidatorConfig
 
getOwner() - Method in interface org.keycloak.authorization.model.PermissionTicket
Returns the resource's owner, which is usually an identifier that uniquely identifies the resource's owner.
getOwner() - Method in interface org.keycloak.authorization.model.Policy
 
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 class org.keycloak.models.utils.FormMessage
 
getParameters() - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
getParams() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getParams() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getParentPolicy() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getPattern(String) - Method in class org.keycloak.validate.ValidatorConfig
Get regex Pattern from the configuration.
getPatternOrDefault(String, Pattern) - Method in class org.keycloak.validate.ValidatorConfig
 
getPemFromCertificate(X509Certificate) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPemFromKey(Key) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPermission() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
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
 
getPermissionTicketStore() - Method in interface org.keycloak.authorization.store.StoreFactory
getPolicy() - Method in interface org.keycloak.authorization.model.PermissionTicket
 
getPolicy() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getPolicy() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns the Policy.
getPolicy() - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
getPolicy() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getPolicy(Policy) - Method in class org.keycloak.authorization.policy.evaluation.Result
 
getPolicyEnforcementMode() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns the PolicyEnforcementMode configured for this instance.
getPolicyEvaluator() - Method in class org.keycloak.authorization.AuthorizationProvider
 
getPolicyStore() - Method in interface org.keycloak.authorization.store.StoreFactory
Returns a PolicyStore.
getPollingInterval() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getPriority() - Method in interface org.keycloak.protocol.ProtocolMapper
Priority of this protocolMapper implementation.
getPrivateKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPropertyNames() - Method in class org.keycloak.component.ComponentModelScope
 
getProtector() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
getProtocol() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getProtocol() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
getProtocol() - Method in interface org.keycloak.protocol.ProtocolMapper
 
getProtocolAuthenticatorMethods(String) - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Get authentication methods for the specified protocol
getProtocolMapperById(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getProtocolMapperByName(String, String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getProtocolMappersStream() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getProvider(String) - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a PolicyProviderFactory given a type.
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.otp.OTPApplicationSpi
 
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.component.ComponentFactorySpi
 
getProviderClass() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getProviderClass() - Method in class org.keycloak.credential.CredentialSpi
 
getProviderClass() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getProviderClass() - Method in class org.keycloak.crypto.CekManagementSpi
 
getProviderClass() - Method in class org.keycloak.crypto.ClientSignatureVerifierSpi
 
getProviderClass() - Method in class org.keycloak.crypto.ContentEncryptionSpi
 
getProviderClass() - Method in class org.keycloak.crypto.HashSpi
 
getProviderClass() - Method in class org.keycloak.crypto.SignatureSpi
 
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.executors.ExecutorsSpi
 
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.headers.SecurityHeadersSpi
 
getProviderClass() - Method in class org.keycloak.keys.KeySpi
 
getProviderClass() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
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.ClientScopeSpi
 
getProviderClass() - Method in class org.keycloak.models.ClientSpi
 
getProviderClass() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getProviderClass() - Method in class org.keycloak.models.DeploymentStateSpi
 
getProviderClass() - Method in class org.keycloak.models.GroupSpi
 
getProviderClass() - Method in class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
getProviderClass() - Method in class org.keycloak.models.RealmSpi
 
getProviderClass() - Method in class org.keycloak.models.RoleSpi
 
getProviderClass() - Method in class org.keycloak.models.SingleUseObjectSpi
 
getProviderClass() - Method in class org.keycloak.models.UserLoginFailureSpi
 
getProviderClass() - Method in class org.keycloak.models.UserSessionSpi
 
getProviderClass() - Method in class org.keycloak.models.UserSpi
 
getProviderClass() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getProviderClass() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getProviderClass() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getProviderClass() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getProviderClass() - Method in class org.keycloak.protocol.oidc.TokenExchangeSpi
 
getProviderClass() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getProviderClass() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getProviderClass() - Method in class org.keycloak.protocol.saml.ArtifactResolverSpi
 
getProviderClass() - Method in class org.keycloak.provider.ExceptionConverterSpi
 
getProviderClass() - Method in class org.keycloak.scripting.ScriptingSpi
 
getProviderClass() - Method in class org.keycloak.services.clientpolicy.ClientPolicyManagerSpi
 
getProviderClass() - Method in class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
getProviderClass() - Method in class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
getProviderClass() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getProviderClass() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getProviderClass() - Method in class org.keycloak.sessions.AuthenticationSessionSpi
 
getProviderClass() - Method in class org.keycloak.sessions.StickySessionEncoderSpi
 
getProviderClass() - Method in class org.keycloak.storage.DatastoreSpi
 
getProviderClass() - Method in class org.keycloak.storage.role.RoleStorageProviderSpi
 
getProviderClass() - Method in class org.keycloak.theme.ThemeSpi
 
getProviderClass() - Method in class org.keycloak.timer.TimerSpi
 
getProviderClass() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getProviderClass() - Method in class org.keycloak.truststore.TruststoreSpi
 
getProviderClass() - Method in class org.keycloak.userprofile.UserProfileSpi
 
getProviderClass() - Method in class org.keycloak.validate.ValidatorSPI
 
getProviderClass() - Method in class org.keycloak.validation.ClientValidationSPI
 
getProviderFactoriesStream() - Method in class org.keycloak.authorization.AuthorizationProvider
Returns the registered PolicyProviderFactory.
getProviderFactory(Class<T>, String, String, Function<KeycloakSessionFactory, ComponentModel>) - Method in interface org.keycloak.component.ComponentFactoryProviderFactory
 
getProviderFactory(String) - Method in class org.keycloak.authorization.AuthorizationProvider
Returns a PolicyProviderFactory given a type.
getProviderFactoryClass() - Method in class org.keycloak.authentication.AuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.ClientAuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.FormActionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.FormAuthenticatorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.authentication.otp.OTPApplicationSpi
 
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.component.ComponentFactorySpi
 
getProviderFactoryClass() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
getProviderFactoryClass() - Method in class org.keycloak.credential.CredentialSpi
 
getProviderFactoryClass() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
getProviderFactoryClass() - Method in class org.keycloak.crypto.CekManagementSpi
 
getProviderFactoryClass() - Method in class org.keycloak.crypto.ClientSignatureVerifierSpi
 
getProviderFactoryClass() - Method in class org.keycloak.crypto.ContentEncryptionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.crypto.HashSpi
 
getProviderFactoryClass() - Method in class org.keycloak.crypto.SignatureSpi
 
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.executors.ExecutorsSpi
 
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.headers.SecurityHeadersSpi
 
getProviderFactoryClass() - Method in class org.keycloak.keys.KeySpi
 
getProviderFactoryClass() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
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.ClientScopeSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.ClientSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.dblock.DBLockSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.DeploymentStateSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.GroupSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.RealmSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.RoleSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.SingleUseObjectSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserLoginFailureSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserSessionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.models.UserSpi
 
getProviderFactoryClass() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.policy.PasswordPolicySpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.oidc.TokenExchangeSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
getProviderFactoryClass() - Method in class org.keycloak.protocol.saml.ArtifactResolverSpi
 
getProviderFactoryClass() - Method in class org.keycloak.provider.ExceptionConverterSpi
 
getProviderFactoryClass() - Method in class org.keycloak.scripting.ScriptingSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.clientpolicy.ClientPolicyManagerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
getProviderFactoryClass() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
getProviderFactoryClass() - Method in class org.keycloak.sessions.AuthenticationSessionSpi
 
getProviderFactoryClass() - Method in class org.keycloak.sessions.StickySessionEncoderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.storage.DatastoreSpi
 
getProviderFactoryClass() - Method in class org.keycloak.storage.role.RoleStorageProviderSpi
 
getProviderFactoryClass() - Method in class org.keycloak.theme.ThemeSpi
 
getProviderFactoryClass() - Method in class org.keycloak.timer.TimerSpi
 
getProviderFactoryClass() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
getProviderFactoryClass() - Method in class org.keycloak.truststore.TruststoreSpi
 
getProviderFactoryClass() - Method in class org.keycloak.userprofile.UserProfileSpi
 
getProviderFactoryClass() - Method in class org.keycloak.validate.ValidatorSPI
 
getProviderFactoryClass() - Method in class org.keycloak.validation.ClientValidationSPI
 
getProviderId() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
 
getProviderId() - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
 
getProviderPriority() - Method in interface org.keycloak.theme.ThemeProvider
 
getProviders() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
getPublicKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getPublicKey(String, String, PublicKeyLoader) - Method in interface org.keycloak.keys.PublicKeyStorageProvider
Get public key to verify messages signed by particular client.
getQualifier() - Method in class org.keycloak.migration.ModelVersion
 
getReadable() - Method in interface org.keycloak.userprofile.Attributes
Returns only the attributes that have read/write permissions.
getReadable() - Method in class org.keycloak.userprofile.DefaultAttributes
 
getReadable(boolean) - Method in interface org.keycloak.userprofile.Attributes
Similar to {Attributes.getReadable(boolean)} but with the possibility to add or remove the root attributes.
getRealm() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Current realm
getRealm() - Method in interface org.keycloak.authentication.FormContext
Current realm
getRealm() - Method in interface org.keycloak.authentication.RequiredActionContext
 
getRealm() - Method in class org.keycloak.authorization.AuthorizationProvider
 
getRealm() - Method in interface org.keycloak.authorization.model.ResourceServer
Returns reference of a realm that this ResourceServer belongs to.
getRealm() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
getRealm() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Returns a Realm that can be used by policies to query information.
getRealm() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
getRealm() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRealm() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getRealm() - Method in class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
getRealm() - Method in class org.keycloak.storage.LegacyStoreSyncEvent
 
getRealmId() - Method in class org.keycloak.events.admin.AdminEvent
Returns the id of the realm
getRealmId() - Method in class org.keycloak.events.admin.AuthDetails
 
getRealmId() - Method in class org.keycloak.events.admin.AuthQuery
 
getRealmId() - Method in class org.keycloak.events.Event
 
getRealmId() - Method in class org.keycloak.scripting.Script
 
getRealmModel() - Method in class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
getRealmRepresentation() - Method in class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
getRealmScopeMappingsStream() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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.
getRedirectUris() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getReferenceCategory() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
General authenticator type, i.e.
getRefreshExecutionUrl() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Get the refresh URL for the required action.
getRefreshUrl(boolean) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Get the refresh URL for the flow.
getRegisteredNodes() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRegistrationToken() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRemoved() - Method in class org.keycloak.storage.LegacyStoreSyncEvent
 
getRep() - Method in class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
getRepresentation() - Method in class org.keycloak.events.admin.AdminEvent
Returns the updated JSON representation if operationType is CREATE or UPDATE.
getRepresentationType() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
getRequestedTokenType() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getRequester() - Method in interface org.keycloak.authorization.model.PermissionTicket
 
getRequiredActions(KeycloakSession) - Method in interface org.keycloak.authentication.Authenticator
Overwrite this if the authenticator is associated with
getRequirementChoices() - Method in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
What requirement settings are allowed.
getResource() - Method in interface org.keycloak.authorization.model.PermissionTicket
Returns the Resource associated with this instance
getResource() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns the resource to which this permission applies.
getResource() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getResource() - Method in interface org.keycloak.services.resource.RealmResourceProvider
Returns a JAX-RS resource instance.
getResource(String) - Method in class org.keycloak.utils.ProxyClassLoader
 
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.
getResources(String) - Method in class org.keycloak.utils.ProxyClassLoader
 
getResourceServer() - Method in interface org.keycloak.authorization.model.PermissionTicket
Returns the ResourceServer where this policy belongs to.
getResourceServer() - Method in interface org.keycloak.authorization.model.Policy
Returns the ResourceServer where this policy belongs to.
getResourceServer() - Method in interface org.keycloak.authorization.model.Resource
Returns the ResourceServer to where this resource belongs to.
getResourceServer() - Method in interface org.keycloak.authorization.model.Scope
Returns the ResourceServer instance to where this scope belongs to.
getResourceServer() - Method in class org.keycloak.authorization.permission.ResourcePermission
Returns the resource server associated with this permission.
getResourceServerStore() - Method in interface org.keycloak.authorization.store.StoreFactory
getResourceStore() - Method in interface org.keycloak.authorization.store.StoreFactory
Returns a ResourceStore.
getResourceType() - Method in class org.keycloak.events.admin.AdminEvent
Returns the type of the affected ResourceType for this AdminEvent, e.g.
getResourceTypeAsString() - Method in class org.keycloak.events.admin.AdminEvent
Returns the type as string.
getResponderURIs(X509Certificate) - Method in class org.keycloak.utils.OCSPProvider
Extracts OCSP responder URI from X509 AIA v3 extension, if available.
getResponse() - Method in exception org.keycloak.authentication.AuthenticationFlowException
 
getResult() - Method in class org.keycloak.cluster.ExecutionResult
 
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
 
getResultStream() - Method in interface org.keycloak.events.admin.AdminEventQuery
Executes the query and returns the results as a stream.
getResultStream() - Method in interface org.keycloak.events.EventQuery
Returns requested results that match given criteria as a stream.
getRevocationReason() - Method in interface org.keycloak.utils.OCSPProvider.OCSPRevocationStatus
 
getRevocationStatus() - Method in interface org.keycloak.utils.OCSPProvider.OCSPRevocationStatus
 
getRevocationTime() - Method in interface org.keycloak.utils.OCSPProvider.OCSPRevocationStatus
 
getRole(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRoleFromString(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getRolesStream() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRolesStream(Integer, Integer) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRootCertificates() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getRootUrl() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getRunnable() - Method in interface org.keycloak.timer.TimerProvider.TimerTaskContext
 
getScope() - Method in interface org.keycloak.authorization.model.PermissionTicket
Returns the Scope associated with this instance
getScope() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getScope() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getScopeMappingsStream() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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.
getScriptModel() - Method in interface org.keycloak.scripting.EvaluatableScriptAdapter
 
getSearchableModelField() - Method in enum org.keycloak.authorization.model.PermissionTicket.FilterOption
 
getSearchableModelField() - Method in enum org.keycloak.authorization.model.Policy.FilterOption
 
getSearchableModelField() - Method in enum org.keycloak.authorization.model.Resource.FilterOption
 
getSearchableModelField() - Method in enum org.keycloak.authorization.model.Scope.FilterOption
 
getSecret() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
getSecretKey(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
getSecretLengthByAuthenticationType(String, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
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
 
getSession() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getSession() - Method in class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
getSession() - Method in class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
getSession() - Method in class org.keycloak.storage.LegacyStoreSyncEvent
 
getSession() - Method in class org.keycloak.userprofile.AttributeContext
 
getSession() - Method in class org.keycloak.validate.ValidationContext
 
getSession() - Method in class org.keycloak.validation.DefaultValidationContext
 
getSession() - Method in interface org.keycloak.validation.ValidationContext
 
getSessionId() - Method in class org.keycloak.events.Event
 
getSingleAttribute(String) - Method in interface org.keycloak.authorization.model.Resource
Returns the first value of an attribute with the given name
getSingleResult() - Method in class org.keycloak.models.utils.reflection.PropertyQuery
Get a single result from the query, causing the query to be run.
getSSLSocketFactory() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getStableIndex() - Method in enum org.keycloak.events.admin.OperationType
 
getStableIndex() - Method in enum org.keycloak.events.EventType
 
getState() - Method in class org.keycloak.broker.provider.AuthenticationRequest
 
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.broker.provider.util.SimpleHttp.Response
 
getStatusCode() - Method in class org.keycloak.userprofile.ValidationException.Error
 
getStatusCode() - Method in exception org.keycloak.userprofile.ValidationException
 
getStatusCode() - Method in class org.keycloak.validate.ValidationError
 
getStoreFactory() - Method in class org.keycloak.authorization.AuthorizationProvider
Cache sits in front of this Returns a StoreFactory.
getStrength() - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
getString(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getStringListOrDefault(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getStringListOrDefault(String, List<String>) - Method in class org.keycloak.validate.ValidatorConfig
 
getStringOrDefault(String, String) - Method in class org.keycloak.validate.ValidatorConfig
 
getStringSet(String) - Method in class org.keycloak.validate.ValidatorConfig
 
getStringSetOrDefault(String, Set<String>) - Method in class org.keycloak.validate.ValidatorConfig
 
getSubjectIssuer() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getSubjectToken() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getSubjectTokenType() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
getSuccessMessage() - Method in exception org.keycloak.authentication.ForkFlowException
 
getSystemClient(RealmModel) - Static method in class org.keycloak.models.utils.SystemClientUtil
 
getTabId() - Method in class org.keycloak.broker.provider.util.IdentityBrokerState
 
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
 
getToken() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getTokenClaim() - Method in enum org.keycloak.models.ImpersonationSessionNote
 
getTokenClaim() - Method in interface org.keycloak.models.UserSessionNoteDescriptor
 
getTokenManager() - Method in class org.keycloak.protocol.oidc.TokenExchangeContext
 
getTransactionManager() - Method in interface org.keycloak.transaction.JtaTransactionManagerLookup
 
getTruststore() - Method in interface org.keycloak.truststore.TruststoreProvider
 
getType() - Method in interface org.keycloak.authorization.model.Policy
Returns the type of this policy.
getType() - Method in interface org.keycloak.authorization.model.Resource
Returns a string representing the type of this resource.
getType() - Method in class org.keycloak.events.Event
 
getType(KeycloakSession) - Method in interface org.keycloak.authentication.CredentialValidator
 
getTypeMetadata() - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
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
 
getUris() - Method in interface org.keycloak.authorization.model.Resource
Returns a List containing all URI that uniquely identify this resource.
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.userprofile.AttributeContext
 
getUserAttribute(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
getUserAttributes(String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Returns all attributes associated with the a user with the given id.
getUserClientRoles(String, String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Returns all client roles granted for a user with the given id.
getUserCode() - Method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
getUserErrorMessage() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
A custom error message that can be displayed to the user
getUserErrorMessage() - Method in exception org.keycloak.authentication.AuthenticationFlowException
 
getUserGroups(String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Returns all groups which the user with the given id is a member.
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 interface org.keycloak.models.OfflineUserSessionModel
 
getUsername() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Username in remote idp
getUserRealmRoles(String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Returns all realm roles granted for a user with the given id.
getUserSessionId() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
getUuidAttributeName(String) - Static method in class org.keycloak.models.LDAPConstants
 
getValidatorConfig() - Method in class org.keycloak.userprofile.AttributeValidatorMetadata
Get validator configuration as map.
getValidatorId() - Method in class org.keycloak.userprofile.AttributeValidatorMetadata
Getters so we can collect validation configurations and provide them to GUI for dynamic client side validations.
getValidatorId() - Method in class org.keycloak.validate.ValidationError
 
getValidators() - Method in class org.keycloak.userprofile.AttributeMetadata
 
getValue(Object) - Method in interface org.keycloak.models.utils.reflection.Property
Returns the property value for the specified bean.
getValue(String) - Method in interface org.keycloak.authorization.attribute.Attributes
Returns a Attributes.Entry from where values can be obtained and parsed accordingly.
getValues(String) - Method in interface org.keycloak.userprofile.Attributes
Returns all values for an attribute with the given name.
getValues(String) - Method in class org.keycloak.userprofile.DefaultAttributes
 
getVersion() - Method in interface org.keycloak.migration.migrators.Migration
 
getWebOrigins() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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)
GOOD - org.keycloak.utils.OCSPProvider.RevocationStatus
 
grant() - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
grant() - Method in interface org.keycloak.authorization.policy.evaluation.Evaluation
Grants the requested permission to the caller.
GRANT_CONSENT - org.keycloak.events.EventType
 
GRANT_CONSENT_ERROR - org.keycloak.events.EventType
 
GRANT_TYPE - Static variable in interface org.keycloak.events.Details
 
GRANTED - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
GRANTED_CLIENT - Static variable in interface org.keycloak.events.Details
 
GRANTED_TIMESTAMP - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
grantPermission(AuthorizationProvider, Set<Permission>, ResourcePermission, Collection<Scope>, ResourceServer, AuthorizationRequest, Result) - Method in class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
grantRole(RoleModel) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
GROUP - org.keycloak.events.admin.ResourceType
 
GROUP - Static variable in interface org.keycloak.broker.provider.ConfigConstants
 
GROUP - Static variable in class org.keycloak.models.LDAPConstants
 
GROUP_MEMBERSHIP - org.keycloak.events.admin.ResourceType
 
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
 
GROUP_PATH_SEPARATOR - Static variable in class org.keycloak.models.utils.KeycloakModelUtils
 
GroupConfigPropertyByPathSynchronizer - Class in org.keycloak.broker.provider.mappersync
Updates a group reference in a mapper config, when the path of a group changes.
GroupProviderFactory<T extends GroupProvider> - Interface in org.keycloak.models
 
groups() - Method in interface org.keycloak.storage.DatastoreProvider
 
GroupSpi - Class in org.keycloak.models
 
GroupSpi() - Constructor for class org.keycloak.models.GroupSpi
 
GroupSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
GroupSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.GroupSynchronizer
 
groupToBriefRepresentation(GroupModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 

H

handleEvent(T, IdentityProviderMapperModel) - Method in class org.keycloak.broker.provider.mappersync.AbstractConfigPropertySynchronizer
 
handleEvent(T, IdentityProviderMapperModel) - Method in interface org.keycloak.broker.provider.mappersync.ConfigSynchronizer
 
hasAddress(long) - Static method in class org.keycloak.models.ClaimMask
 
hasClientRole(String, String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a client role with the given roleName.
hasDirectScope(RoleModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
hasEmail(long) - Static method in class org.keycloak.models.ClaimMask
 
hasError(String...) - Method in exception org.keycloak.userprofile.ValidationException
 
hasErrorsForInputHint(String) - Method in class org.keycloak.validate.ValidationResult
Checks if this ValidationResult contains ValidationError's with the given inputHint.
hasErrorsForValidatorId(String) - Method in class org.keycloak.validate.ValidationResult
Checks if this ValidationResult contains ValidationError's from the Validator with the given id.
hasGender(long) - Static method in class org.keycloak.models.ClaimMask
 
hash(byte[]) - Method in interface org.keycloak.crypto.HashProvider
 
hash(String) - Method in interface org.keycloak.crypto.HashProvider
 
HashAlgorithmPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HashAlgorithmPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
hashCode() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate.WithId
 
hashCode() - Method in class org.keycloak.userprofile.AttributeMetadata
 
hashCode() - Method in class org.keycloak.userprofile.AttributeValidatorMetadata
 
hashCode() - Method in class org.keycloak.userprofile.UserProfileMetadata
 
hashCode() - Method in class org.keycloak.validate.ValidationError
 
hashCode() - Method in class org.keycloak.validation.ValidationError
 
HashIterationsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HashIterationsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
HashProvider - Interface in org.keycloak.crypto
 
HashProviderFactory - Interface in org.keycloak.crypto
 
HashSpi - Class in org.keycloak.crypto
 
HashSpi() - Constructor for class org.keycloak.crypto.HashSpi
 
hasLocale(long) - Static method in class org.keycloak.models.ClaimMask
 
hasMapperAssignedGroup(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Verifies if a mapper has already assigned the specified group.
hasMapperGrantedRole(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
Verifies if a mapper has already granted the specified role.
hasName(long) - Static method in class org.keycloak.models.ClaimMask
 
hasOneClientRole(String, String...) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a client role of one of the given roleNames.
hasPath(String) - Static method in class org.keycloak.utils.JsonUtils
Determines if the given claim contains paths.
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
 
hasProvider(RealmModel, String) - Static method in class org.keycloak.models.utils.DefaultKeyProviders
 
hasRealmRole(String) - Method in interface org.keycloak.authorization.identity.Identity
Indicates if this identity is granted with a realm role with the given roleName.
hasScope(RoleModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
hasServices() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
hasTheme(String, Theme.Type) - Method in interface org.keycloak.theme.ThemeProvider
 
hasThemeResources() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
hasThemes() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
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
 
HistoryPasswordPolicyProvider - Class in org.keycloak.policy
 
HistoryPasswordPolicyProvider(KeycloakSession) - Constructor for class org.keycloak.policy.HistoryPasswordPolicyProvider
 
HistoryPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
HistoryPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
HostnameVerificationPolicy - Enum in org.keycloak.truststore
 
HTTP_CHALLENGE_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
httpChallengeFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
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 - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
ID - org.keycloak.authorization.model.Policy.FilterOption
 
ID - org.keycloak.authorization.model.Resource.FilterOption
 
ID - org.keycloak.authorization.model.Scope.FilterOption
 
ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
ID - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
ID - Static variable in class org.keycloak.authorization.model.ResourceServer.SearchableFields
 
ID - Static variable in class org.keycloak.authorization.model.Scope.SearchableFields
 
ID - Static variable in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
ID - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
ID - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
ID - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
ID - Static variable in class org.keycloak.events.Event.SearchableFields
 
ID - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
ID - Static variable in class org.keycloak.userprofile.UserProfileSpi
 
ID - Static variable in class org.keycloak.validate.validators.DoubleValidator
 
ID - Static variable in class org.keycloak.validate.validators.EmailValidator
 
ID - Static variable in class org.keycloak.validate.validators.IntegerValidator
 
ID - Static variable in class org.keycloak.validate.validators.LengthValidator
 
ID - Static variable in class org.keycloak.validate.validators.LocalDateValidator
 
ID - Static variable in class org.keycloak.validate.validators.NotBlankValidator
 
ID - Static variable in class org.keycloak.validate.validators.NotEmptyValidator
 
ID - Static variable in class org.keycloak.validate.validators.OptionsValidator
 
ID - Static variable in class org.keycloak.validate.validators.PatternValidator
 
ID - Static variable in class org.keycloak.validate.validators.UriValidator
 
ID - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
 
ID_TOKEN_AS_DETACHED_SIGNATURE - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
ID_TOKEN_ENCRYPTED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
ID_TOKEN_ENCRYPTED_RESPONSE_ENC - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
ID_TOKEN_SIGNED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
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 - org.keycloak.events.admin.ResourceType
 
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_DISABLED - org.keycloak.authentication.AuthenticationFlowError
 
IDENTITY_PROVIDER_ERROR - org.keycloak.authentication.AuthenticationFlowError
 
IDENTITY_PROVIDER_ERROR - Static variable in interface org.keycloak.events.Errors
 
IDENTITY_PROVIDER_FIRST_LOGIN - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_FIRST_LOGIN_ERROR - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_LINK_ACCOUNT - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_LINK_ACCOUNT_ERROR - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_LOGIN - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_LOGIN_ERROR - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_LOGIN_FAILURE - Static variable in interface org.keycloak.events.Errors
 
IDENTITY_PROVIDER_MAPPER - org.keycloak.events.admin.ResourceType
 
IDENTITY_PROVIDER_NOT_FOUND - org.keycloak.authentication.AuthenticationFlowError
 
IDENTITY_PROVIDER_POST_LOGIN - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_POST_LOGIN_ERROR - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_RESPONSE - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_RESPONSE_ERROR - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_RETRIEVE_TOKEN - org.keycloak.events.EventType
 
IDENTITY_PROVIDER_RETRIEVE_TOKEN_ERROR - org.keycloak.events.EventType
 
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
 
IdentityBrokerState - Class in org.keycloak.broker.provider.util
Encapsulates parsing logic related to state passed to identity provider in "state" (or RelayState) parameter
IdentityProvider<C extends IdentityProviderModel> - Interface in org.keycloak.broker.provider
 
IdentityProvider.AuthenticationCallback - Interface in org.keycloak.broker.provider
 
IdentityProviderDataMarshaller - Interface in org.keycloak.broker.provider
 
IdentityProviderFactory<T extends IdentityProvider> - Interface in org.keycloak.broker.provider
 
IdentityProviderMapper - Interface in org.keycloak.broker.provider
 
IdentityProviderMapperSpi - Class in org.keycloak.broker.provider
 
IdentityProviderMapperSpi() - Constructor for class org.keycloak.broker.provider.IdentityProviderMapperSpi
 
IdentityProviderMapperSyncModeDelegate - Class in org.keycloak.broker.provider
 
IdentityProviderMapperSyncModeDelegate() - Constructor for class org.keycloak.broker.provider.IdentityProviderMapperSyncModeDelegate
 
IdentityProviderSpi - Class in org.keycloak.broker.provider
 
IdentityProviderSpi() - Constructor for class org.keycloak.broker.provider.IdentityProviderSpi
 
IDLE_TIMEOUT_WINDOW_SECONDS - Static variable in class org.keycloak.models.utils.SessionTimeoutHelper
The maximum time difference, which will be still tolerated when checking userSession idle timeout.
IDP_CREATE_UNIQUE_USER_CONFIG_ALIAS - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
IDP_REVIEW - org.keycloak.userprofile.UserProfileContext
 
IDP_REVIEW_PROFILE_CONFIG_ALIAS - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
IDP_REVIEW_USER_PROFILE - org.keycloak.forms.login.LoginFormsPages
 
ifNotValidAccept(Consumer<ValidationResult>) - Method in class org.keycloak.validate.ValidationResult
Convenience method that accepts a Consumer if the result is not valid.
ignore() - Method in interface org.keycloak.authentication.RequiredActionContext
Ignore this required action and go onto the next, or complete the flow.
IGNORE - org.keycloak.authentication.RequiredActionContext.Status
 
IGNORE_EMPTY_VALUE - Static variable in class org.keycloak.validate.AbstractSimpleValidator
Config option which allows to switch validator to ignore null, empty string and even blank string value - not to produce error for them.
IGNORE_EXISTING - org.keycloak.exportimport.Strategy
 
ILLEGAL_ORIGIN - Static variable in interface org.keycloak.events.Errors
 
IMPERSONATE - org.keycloak.events.EventType
 
IMPERSONATE_ERROR - org.keycloak.events.EventType
 
IMPERSONATION_ROLE - Static variable in class org.keycloak.models.ImpersonationConstants
 
ImpersonationConstants - Class in org.keycloak.models
 
ImpersonationConstants() - Constructor for class org.keycloak.models.ImpersonationConstants
 
ImpersonationSessionNote - Enum in org.keycloak.models
Session note metadata for impersonation details stored in user session notes.
IMPERSONATOR - Static variable in interface org.keycloak.events.Details
 
IMPERSONATOR_CLIENT - org.keycloak.models.ImpersonationSessionNote
 
IMPERSONATOR_ID - org.keycloak.models.ImpersonationSessionNote
 
IMPERSONATOR_REALM - Static variable in interface org.keycloak.events.Details
 
IMPERSONATOR_USERNAME - org.keycloak.models.ImpersonationSessionNote
 
importAuthorizationSettings(ClientRepresentation, ClientModel, KeycloakSession) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importGroup(RealmModel, GroupModel, GroupRepresentation) - 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, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
importNewUser(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
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(InputStream) - Method in interface org.keycloak.storage.ExportImportManager
 
importRealm(KeycloakSessionFactory, String, Strategy) - Method in interface org.keycloak.exportimport.ImportProvider
 
importRealm(KeycloakSession, RealmRepresentation, RealmModel, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
importRealm(RealmRepresentation, RealmModel, boolean) - Method in interface org.keycloak.storage.ExportImportManager
 
ImportRealmFromRepresentation - Class in org.keycloak.storage
Deprecated.
ImportRealmFromRepresentation(KeycloakSession, RealmRepresentation) - Constructor for class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
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
 
INFO - org.keycloak.forms.login.LoginFormsPages
 
init(Config.Scope) - Method in interface org.keycloak.authentication.otp.OTPApplicationProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
init(Config.Scope) - Method in interface org.keycloak.credential.CredentialProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.crypto.CekManagementProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.crypto.ClientSignatureVerifierProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.crypto.ContentEncryptionProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.crypto.HashProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.crypto.SignatureProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.headers.SecurityHeadersProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.keys.KeyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
init(Config.Scope) - Method in interface org.keycloak.provider.ExceptionConverter
 
init(Config.Scope) - Method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
init(Config.Scope) - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
init(Config.Scope) - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
init(Config.Scope) - Method in interface org.keycloak.validate.SimpleValidator
 
init(Config.Scope) - Method in interface org.keycloak.validation.ClientValidationProviderFactory
 
initiatedActionCanceled(KeycloakSession, AuthenticationSessionModel) - Method in interface org.keycloak.authentication.RequiredActionProvider
Callback to let the action know that an application-initiated action was canceled.
initiatedActionSupport() - Method in interface org.keycloak.authentication.RequiredActionProvider
Determines what type of support is provided for application-initiated actions.
InitiatedActionSupport - Enum in org.keycloak.authentication
 
INSTALLED_APP_LOOPBACK - Static variable in class org.keycloak.models.Constants
 
INSTALLED_APP_URL - Static variable in class org.keycloak.models.Constants
 
INSTALLED_APP_URN - Static variable in class org.keycloak.models.Constants
 
INSTANCE - Static variable in class org.keycloak.broker.provider.mappersync.GroupConfigPropertyByPathSynchronizer
 
INSTANCE - Static variable in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByClientIdSynchronizer
 
INSTANCE - Static variable in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByRoleNameSynchronizer
 
INSTANCE - Static variable in class org.keycloak.validate.validators.DoubleValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.EmailValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.IntegerValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.LengthValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.LocalDateValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.NotBlankValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.NotEmptyValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.OptionsValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.PatternValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.UriValidator
 
INSTANCE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
 
integerValidator() - Static method in class org.keycloak.validate.Validators
 
IntegerValidator - Class in org.keycloak.validate.validators
Validate input being integer number Integer or Long.
IntegerValidator() - Constructor for class org.keycloak.validate.validators.IntegerValidator
 
IntegerValidator(ValidatorConfig) - Constructor for class org.keycloak.validate.validators.IntegerValidator
 
INTERNAL_ERROR - org.keycloak.authentication.AuthenticationFlowError
 
introspect(String) - Method in interface org.keycloak.protocol.oidc.TokenIntrospectionProvider
Introspect the token.
INTROSPECT_TOKEN - org.keycloak.events.EventType
 
INTROSPECT_TOKEN_ERROR - org.keycloak.events.EventType
 
INVALID_CLIENT - Static variable in interface org.keycloak.events.Errors
 
INVALID_CLIENT_CREDENTIALS - org.keycloak.authentication.AuthenticationFlowError
 
INVALID_CLIENT_CREDENTIALS - Static variable in interface org.keycloak.events.Errors
 
INVALID_CLIENT_SESSION - org.keycloak.authentication.AuthenticationFlowError
 
INVALID_CODE - Static variable in interface org.keycloak.events.Errors
 
INVALID_CODE_CHALLENGE_METHOD - Static variable in interface org.keycloak.events.Errors
 
INVALID_CODE_VERIFIER - Static variable in interface org.keycloak.events.Errors
 
INVALID_CONFIG - Static variable in interface org.keycloak.events.Errors
 
INVALID_CREDENTIALS - org.keycloak.authentication.AuthenticationFlowError
 
INVALID_DESTINATION - 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_INPUT - Static variable in interface org.keycloak.events.Errors
 
INVALID_ISSUER - Static variable in interface org.keycloak.events.Errors
 
INVALID_OAUTH2_DEVICE_CODE - Static variable in interface org.keycloak.events.Errors
 
INVALID_OAUTH2_USER_CODE - Static variable in interface org.keycloak.events.Errors
 
INVALID_PERMISSION_TICKET - Static variable in interface org.keycloak.events.Errors
 
INVALID_REDIRECT_URI - Static variable in interface org.keycloak.events.Errors
 
INVALID_REGISTRATION - Static variable in interface org.keycloak.events.Errors
 
INVALID_REQUEST - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_ARTIFACT - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_ARTIFACT_RESPONSE - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_AUTHN_REQUEST - Static variable in interface org.keycloak.events.Errors
 
INVALID_SAML_DOCUMENT - 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 - org.keycloak.events.EventType
 
INVALID_SIGNATURE - Static variable in interface org.keycloak.events.Errors
 
INVALID_SIGNATURE_ERROR - org.keycloak.events.EventType
 
INVALID_TOKEN - Static variable in interface org.keycloak.events.Errors
 
INVALID_TOKEN_TYPE - Static variable in interface org.keycloak.events.Errors
 
INVALID_USER - org.keycloak.authentication.AuthenticationFlowError
 
INVALID_USER_CREDENTIALS - Static variable in interface org.keycloak.events.Errors
 
invalidate() - Method in interface org.keycloak.authorization.model.CachedModel
Invalidate the cache for this model
InvocableScriptAdapter - Class in org.keycloak.scripting
Wraps a ScriptModel and makes it Invocable.
InvocableScriptAdapter(ScriptModel, ScriptEngine) - Constructor for class org.keycloak.scripting.InvocableScriptAdapter
Creates a new InvocableScriptAdapter instance.
invokeFunction(String, Object...) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
invokeMethod(Object, String, Object...) - Method in class org.keycloak.scripting.InvocableScriptAdapter
 
IP_ADDRESS - Static variable in class org.keycloak.events.Event.SearchableFields
 
ipAddress(String) - Method in class org.keycloak.events.EventBuilder
 
ipAddress(String) - Method in interface org.keycloak.events.EventQuery
Search events from ipAddress
IS_AIA_REQUEST - Static variable in class org.keycloak.models.Constants
 
IS_NEGATIVE_LOGIC - Static variable in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
isActionAvailable(RequiredActionProviderModel) - Static method in class org.keycloak.models.utils.DefaultRequiredActions
Check whether the action is the default one used in a realm and is available in the application Often, the default actions can be disabled due to the fact a particular feature is disabled
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.
isAlwaysDisplayInConsole() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isAnnotationPresent(Class<? extends Annotation>) - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether the given annotation is defined for this property.
isAsymmetricAlgorithm() - Method in interface org.keycloak.crypto.SignatureProvider
 
isAttributeOnError(String...) - Method in exception org.keycloak.userprofile.ValidationException
Checks if there are validation errors related to the attribute with the given name.
isAvailable() - Method in enum org.keycloak.models.utils.DefaultRequiredActions.Action
 
isBearerOnly() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isClientsIncluded() - Method in class org.keycloak.exportimport.ExportOptions
 
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 class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isDefined(String) - Method in class org.keycloak.scripting.InvocableScriptAdapter
Returns true if the ScriptEngine has a definition with the given name.
isDenied() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
isDirectAccessGrantsEnabled() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isDisplayOnConsentScreen() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isDownloadOnly() - Method in interface org.keycloak.protocol.ClientInstallationProvider
 
isDynamicScope() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isEmpty() - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
isEmpty() - Method in class org.keycloak.validate.ValidatorConfig
 
isEnabled() - Method in class org.keycloak.authorization.AuthorizationSpi
 
isEnabled() - Method in class org.keycloak.authorization.policy.provider.PolicySpi
 
isEnabled() - Method in class org.keycloak.authorization.store.StoreFactorySpi
 
isEnabled() - Method in class org.keycloak.models.cache.authorization.CachedStoreFactorySpi
 
isEnabled() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isEnabled(KeycloakSession, Class<?>) - Static method in class org.keycloak.utils.LockObjectsForModification
 
isExceptionRetriable(Exception) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Checks if the specified exception is retriable or not.
isExecuted() - Method in class org.keycloak.cluster.ExecutionResult
 
isExpired() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
isFirstGreaterThanToSecond(Number, Number) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
isFirstGreaterThanToSecond(Number, Number) - Method in class org.keycloak.validate.validators.DoubleValidator
 
isFirstGreaterThanToSecond(Number, Number) - Method in class org.keycloak.validate.validators.IntegerValidator
 
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 class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isFullScopeAllowed() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isGranted() - Method in interface org.keycloak.authorization.model.PermissionTicket
 
isGranted() - Method in class org.keycloak.authorization.permission.ResourcePermission
 
isGranted(Result.PolicyResult) - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
isGroupInRole(String, String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Checks whether or not a group is granted with the given realm role.
isGroupsAndRolesIncluded() - Method in class org.keycloak.exportimport.ExportOptions
 
isIgnoreEmptyValuesConfigured(ValidatorConfig) - Method in class org.keycloak.validate.AbstractSimpleValidator
Default implementation only looks for AbstractSimpleValidator.IGNORE_EMPTY_VALUE configuration option.
isIgnoreEmptyValuesConfigured(ValidatorConfig) - Method in class org.keycloak.validate.validators.LocalDateValidator
 
isImplicitFlowEnabled() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isIncludeAttributeIfNotProvided(AttributeMetadata) - Method in class org.keycloak.userprofile.DefaultAttributes
 
isIncludeInTokenScope() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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.otp.OTPApplicationSpi
 
isInternal() - Method in class org.keycloak.authentication.RequiredActionSpi
 
isInternal() - Method in class org.keycloak.authorization.AuthorizationSpi
 
isInternal() - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
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.component.ComponentFactorySpi
 
isInternal() - Method in class org.keycloak.connections.httpclient.HttpClientSpi
 
isInternal() - Method in class org.keycloak.credential.CredentialSpi
 
isInternal() - Method in class org.keycloak.credential.hash.PasswordHashSpi
 
isInternal() - Method in class org.keycloak.crypto.CekManagementSpi
 
isInternal() - Method in class org.keycloak.crypto.ClientSignatureVerifierSpi
 
isInternal() - Method in class org.keycloak.crypto.ContentEncryptionSpi
 
isInternal() - Method in class org.keycloak.crypto.HashSpi
 
isInternal() - Method in class org.keycloak.crypto.SignatureSpi
 
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.executors.ExecutorsSpi
 
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.headers.SecurityHeadersSpi
 
isInternal() - Method in class org.keycloak.keys.KeySpi
 
isInternal() - Method in class org.keycloak.keys.PublicKeyStorageSpi
 
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.ClientScopeSpi
 
isInternal() - Method in class org.keycloak.models.ClientSpi
 
isInternal() - Method in class org.keycloak.models.dblock.DBLockSpi
 
isInternal() - Method in class org.keycloak.models.DeploymentStateSpi
 
isInternal() - Method in class org.keycloak.models.GroupSpi
 
isInternal() - Method in class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
isInternal() - Method in class org.keycloak.models.RealmSpi
 
isInternal() - Method in class org.keycloak.models.RoleSpi
 
isInternal() - Method in class org.keycloak.models.SingleUseObjectSpi
 
isInternal() - Method in class org.keycloak.models.UserLoginFailureSpi
 
isInternal() - Method in class org.keycloak.models.UserSessionSpi
 
isInternal() - Method in class org.keycloak.models.UserSpi
 
isInternal() - Method in class org.keycloak.policy.PasswordPolicyManagerSpi
 
isInternal() - Method in class org.keycloak.policy.PasswordPolicySpi
 
isInternal() - Method in class org.keycloak.protocol.ClientInstallationSpi
 
isInternal() - Method in class org.keycloak.protocol.LoginProtocolSpi
 
isInternal() - Method in class org.keycloak.protocol.oidc.TokenExchangeSpi
 
isInternal() - Method in class org.keycloak.protocol.oidc.TokenIntrospectionSpi
 
isInternal() - Method in class org.keycloak.protocol.ProtocolMapperSpi
 
isInternal() - Method in class org.keycloak.protocol.saml.ArtifactResolverSpi
 
isInternal() - Method in class org.keycloak.provider.ExceptionConverterSpi
 
isInternal() - Method in class org.keycloak.scripting.ScriptingSpi
 
isInternal() - Method in class org.keycloak.services.clientpolicy.ClientPolicyManagerSpi
 
isInternal() - Method in class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
isInternal() - Method in class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
isInternal() - Method in class org.keycloak.services.managers.BruteForceProtectorSpi
 
isInternal() - Method in class org.keycloak.services.resource.RealmResourceSPI
 
isInternal() - Method in class org.keycloak.sessions.AuthenticationSessionSpi
 
isInternal() - Method in class org.keycloak.sessions.StickySessionEncoderSpi
 
isInternal() - Method in class org.keycloak.storage.DatastoreSpi
 
isInternal() - Method in class org.keycloak.storage.role.RoleStorageProviderSpi
 
isInternal() - Method in class org.keycloak.theme.ThemeSpi
 
isInternal() - Method in class org.keycloak.timer.TimerSpi
 
isInternal() - Method in class org.keycloak.transaction.TransactionManagerLookupSpi
 
isInternal() - Method in class org.keycloak.truststore.TruststoreSpi
 
isInternal() - Method in class org.keycloak.userprofile.UserProfileSpi
 
isInternal() - Method in class org.keycloak.validate.ValidatorSPI
 
isInternal() - Method in class org.keycloak.validation.ClientValidationSPI
 
isIssuer(String, MultivaluedMap<String, String>) - Method in interface org.keycloak.broker.provider.ExchangeExternalToken
 
isMasterRealmExported() - Method in interface org.keycloak.exportimport.ImportProvider
 
isMultiplSupported() - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
isMultiplSupported() - Method in interface org.keycloak.policy.PasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
isMultiplSupported() - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
isNegativeLogic() - Method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider
 
isNegativeLogic() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
tells whether the result of applyPolicy method is inverted or not as follows.
isOIDCNonBearerOnlyClient(ClientModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
isOneTimeAction() - Method in interface org.keycloak.authentication.RequiredActionFactory
Flag indicating whether the execution of the required action by the same circumstances (e.g.
isOnlyServiceAccountsIncluded() - Method in class org.keycloak.exportimport.ExportOptions
 
isOwnerManagedAccess() - Method in interface org.keycloak.authorization.model.Resource
Indicates if this resource can be managed by the resource owner.
isPending() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
isPermanentlyLockedOut(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
isProperty(Method) - Static method in class org.keycloak.models.utils.reflection.Properties
Indicates whether this method is a valid property method.
isProvider() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
isPublicClient() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isReadOnly() - Method in interface org.keycloak.authorization.store.StoreFactory
Indicates if instances returned from storage are read-only.
isReadOnly() - Method in interface org.keycloak.models.utils.reflection.Property
Indicates whether this is a read-only property
isReadOnly(String) - Method in interface org.keycloak.userprofile.Attributes
Checks whether an attribute is read-only.
isReadOnly(String) - Method in class org.keycloak.userprofile.DefaultAttributes
 
isReadOnly(AttributeContext) - Method in class org.keycloak.userprofile.AttributeMetadata
 
isReadOnlyFromMetadata(String) - Method in class org.keycloak.userprofile.DefaultAttributes
Checks whether an attribute is marked as read only by looking at its metadata.
isReadOnlyInternalAttribute(String) - Method in class org.keycloak.userprofile.DefaultAttributes
Returns whether an attribute is read only based on the provider configuration (using provider config), usually related to internal attributes managed by the server.
isRealmProviderJpa(KeycloakSession) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
isRequired(String) - Method in interface org.keycloak.userprofile.Attributes
Returns whether the attribute with the given name is required.
isRequired(String) - Method in class org.keycloak.userprofile.DefaultAttributes
 
isRequired(AttributeContext) - Method in class org.keycloak.userprofile.AttributeMetadata
Check if attribute is required based on it's predicate, it is handled as required if predicate is null
isResetEmailVerified() - Method in enum org.keycloak.userprofile.UserProfileContext
 
isRootAttribute(String) - Method in interface org.keycloak.userprofile.Attributes
Returns whether the attribute with the given name is a root attribute.
isSaveByDefault() - Method in enum org.keycloak.events.EventType
Determines whether this event is stored when the admin has not set a specific set of event types to save.
isSelected(AttributeContext) - Method in class org.keycloak.userprofile.AttributeMetadata
 
isServiceAccountsEnabled() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isSkipUserDependent() - Method in class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
isStandardFlowEnabled() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isSuccessful() - Method in interface org.keycloak.authentication.AuthenticationFlow
 
isSupported() - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
isSupported() - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
isSupported() - Method in interface org.keycloak.provider.EnvironmentDependentProviderFactory
Deprecated.
isSupported() - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProviderFactory
 
isSupported() - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProviderFactory
 
isSupported() - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
isSupported(Config.Scope) - Method in interface org.keycloak.provider.EnvironmentDependentProviderFactory
An alternative to EnvironmentDependentProviderFactory.isSupported() method to check if the provider is supported based on the provider configuration.
isSupportedAttribute(String) - Method in class org.keycloak.userprofile.DefaultAttributes
Checks whether an attribute is support by the profile configuration and the current context.
isSurrogateAuthRequired() - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
isTemporarilyDisabled(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
isUserInClientRole(String, String, String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Checks whether or not a user with the given id is granted with the given client role.
isUserInGroup(String, String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Checks whether or not a user with the given id is a member of the given group.
isUserInGroup(String, String, boolean) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Checks whether or not a user with the given id is a member of the given group.
isUserInRealmRole(String, String) - Method in interface org.keycloak.authorization.policy.evaluation.Realm
Checks whether or not a user with the given id is granted with the given realm role.
isUsernameCaseSensitive(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Returns true if given realm has attribute Constants.REALM_ATTR_USERNAME_CASE_SENSITIVE set and its value is true.
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?
isUsersIncluded() - Method in class org.keycloak.exportimport.ExportOptions
 
isValid() - Method in class org.keycloak.validate.ValidationContext
Convenience method for checking the validation status of the current ValidationContext.
isValid() - Method in class org.keycloak.validate.ValidationResult
 
isValid() - Method in class org.keycloak.validation.ValidationResult
 

J

JBOSS_SERVER_DATA_DIR - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
joinGroup(GroupModel) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
JPEG_PHOTO - Static variable in class org.keycloak.models.LDAPConstants
 
json(Object) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
JsonUtils - Class in org.keycloak.utils
Utility methods for manipulating JSON objects.
JsonUtils() - Constructor for class org.keycloak.utils.JsonUtils
 
JtaTransactionManagerLookup - Interface in org.keycloak.transaction
JTA TransactionManager lookup
jweAlgorithmProvider() - Method in interface org.keycloak.crypto.CekManagementProvider
 
jweEncryptionProvider() - Method in interface org.keycloak.crypto.ContentEncryptionProvider
 
JWKS_STRING - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
JWKS_URL - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 

K

KC_ACTION - Static variable in class org.keycloak.models.Constants
 
KC_ACTION_EXECUTING - Static variable in class org.keycloak.models.Constants
 
KC_ACTION_MAX_AGE - Static variable in class org.keycloak.models.Constants
 
KC_ACTION_STATUS - Static variable in class org.keycloak.models.Constants
 
KEY - Static variable in class org.keycloak.models.Constants
 
KEY_ALLOW_FRAGMENT - Static variable in class org.keycloak.validate.validators.UriValidator
 
KEY_ALLOWED_SCHEMES - Static variable in class org.keycloak.validate.validators.UriValidator
 
KEY_MAX - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
KEY_MAX - Static variable in class org.keycloak.validate.validators.LengthValidator
 
KEY_MIN - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
KEY_MIN - Static variable in class org.keycloak.validate.validators.LengthValidator
 
KEY_OPTIONS - Static variable in class org.keycloak.validate.validators.OptionsValidator
 
KEY_REQUIRE_VALID_URL - Static variable in class org.keycloak.validate.validators.UriValidator
 
KEY_TRIM_DISABLED - Static variable in class org.keycloak.validate.validators.LengthValidator
 
KEYCLOAK_BOOT - org.keycloak.models.dblock.DBLockProvider.Namespace
 
KeycloakDeploymentInfo - Class in org.keycloak.provider
 
keycloakInitiatedBrowserLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
keycloakInitiatedBrowserLogout(KeycloakSession, UserSessionModel, UriInfo, RealmModel) - Method in interface org.keycloak.broker.provider.IdentityProvider
Called when a Keycloak application initiates a logout through the browser.
KeycloakModelUtils - Class in org.keycloak.models.utils
Set of helper methods, which are useful in various model implementations.
KeyProvider - Interface in org.keycloak.keys
 
KeyProviderFactory<T extends KeyProvider> - Interface in org.keycloak.keys
 
KeySpi - Class in org.keycloak.keys
 
KeySpi() - Constructor for class org.keycloak.keys.KeySpi
 

L

LAST_NAME - Static variable in interface org.keycloak.events.Details
 
LDAP_ENTRY_DN - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_ID - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_MATCHING_RULE_IN_CHAIN - Static variable in class org.keycloak.models.LDAPConstants
 
LDAP_PROVIDER - Static variable in class org.keycloak.models.LDAPConstants
 
LDAPConstants - Class in org.keycloak.models
 
LDAPConstants() - Constructor for class org.keycloak.models.LDAPConstants
 
leaveGroup(GroupModel) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
LegacySessionSupportProvider - Interface in org.keycloak.models
Support for elements in Keycloak's session that are deprecated.
LegacyStoreMigrateRepresentationEvent - Class in org.keycloak.storage
Event for notifying legacy store, so it can do migrations on the representation as needed.
LegacyStoreMigrateRepresentationEvent(KeycloakSession, RealmModel, RealmRepresentation, boolean) - Constructor for class org.keycloak.storage.LegacyStoreMigrateRepresentationEvent
 
LegacyStoreSyncEvent - Class in org.keycloak.storage
Event for notifying legacy store about the need to reconfigure user providers sychronization.
LegacyStoreSyncEvent(KeycloakSession, RealmModel, boolean) - Constructor for class org.keycloak.storage.LegacyStoreSyncEvent
 
LengthPasswordPolicyProvider - Class in org.keycloak.policy
 
LengthPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.LengthPasswordPolicyProvider
 
LengthPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
LengthPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
lengthValidator() - Static method in class org.keycloak.validate.Validators
 
LengthValidator - Class in org.keycloak.validate.validators
String value length validation - accepts plain string and collection of strings, for basic behavior like null/blank values handling and collections support see AbstractStringValidator.
LengthValidator() - Constructor for class org.keycloak.validate.validators.LengthValidator
 
lessThan(ModelVersion) - Method in class org.keycloak.migration.ModelVersion
 
LEVEL_OF_AUTHENTICATION - Static variable in class org.keycloak.models.Constants
 
LOA_MAP - Static variable in class org.keycloak.models.Constants
 
load(Spi) - Method in interface org.keycloak.provider.ProviderLoader
Load all provider factories of a specific SPI.
loadClass(String) - Method in class org.keycloak.utils.ProxyClassLoader
 
loadKeys() - Method in interface org.keycloak.keys.PublicKeyLoader
 
loadPersistentSessions(KeycloakSessionFactory, int, int) - Method in interface org.keycloak.models.UserSessionProviderFactory
 
loadSpis() - Method in interface org.keycloak.provider.ProviderLoader
Load the SPI definitions themselves.
LOCAL_DC_ONLY - org.keycloak.cluster.ClusterProvider.DCNotify
Deprecated.
Send message to all cluster nodes on THIS datacenter only
LocalDateValidator - Class in org.keycloak.validate.validators
A date validator that only takes into account the format associated with the current locale.
LocalDateValidator() - Constructor for class org.keycloak.validate.validators.LocalDateValidator
 
LOCALE - Static variable in class org.keycloak.models.ClaimMask
 
LockObjectsForModification - Class in org.keycloak.utils
This flags the session that all information loaded from the stores should be locked as the service layer plans to modify it.
LockObjectsForModification() - Constructor for class org.keycloak.utils.LockObjectsForModification
 
LockObjectsForModification.CallableWithoutThrowingAnException<V> - Interface in org.keycloak.utils
 
LockObjectsForModification.Enabled - Class in org.keycloak.utils
 
lockRealmsForModification(KeycloakSession, LockObjectsForModification.CallableWithoutThrowingAnException<V>) - Static method in class org.keycloak.utils.LockObjectsForModification
 
lockUserSessionsForModification(KeycloakSession, LockObjectsForModification.CallableWithoutThrowingAnException<V>) - Static method in class org.keycloak.utils.LockObjectsForModification
 
LOG - org.keycloak.forms.account.AccountPages
 
logger - Static variable in class org.keycloak.broker.provider.IdentityProviderMapperSyncModeDelegate
 
logger - Static variable in class org.keycloak.models.dblock.DBLockManager
 
LOGIN - org.keycloak.events.EventType
 
LOGIN - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_CONFIG_TOTP - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_ERROR - org.keycloak.events.EventType
 
LOGIN_FORMS_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
LOGIN_IDP_LINK_CONFIRM - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_IDP_LINK_EMAIL - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_OAUTH2_DEVICE_VERIFY_USER_CODE - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_PAGE_EXPIRED - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_PASSWORD - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_RECOVERY_AUTHN_CODES_CONFIG - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_RECOVERY_AUTHN_CODES_INPUT - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_RESET_PASSWORD - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_SELECT_AUTHENTICATOR - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_TOTP - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_UPDATE_PASSWORD - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_UPDATE_PROFILE - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_USERNAME - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_VERIFY_EMAIL - org.keycloak.forms.login.LoginFormsPages
 
LOGIN_WEBAUTHN - org.keycloak.forms.login.LoginFormsPages
 
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
 
LOGOUT - org.keycloak.events.EventType
 
LOGOUT_CONFIRM - org.keycloak.forms.login.LoginFormsPages
 
LOGOUT_ERROR - org.keycloak.events.EventType
 
LOGOUT_FAILED - Static variable in interface org.keycloak.events.Errors
 
LowerCasePasswordPolicyProvider - Class in org.keycloak.policy
 
LowerCasePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
LowerCasePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
LowerCasePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 

M

MANAGE_ACCOUNT - Static variable in interface org.keycloak.models.AccountRoles
 
MANAGE_ACCOUNT_LINKS - 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_CONSENT - Static variable in interface org.keycloak.models.AccountRoles
 
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
 
ManagedCacheManagerProvider - Interface in org.keycloak.cluster
A Service Provider Interface (SPI) that allows to plug-in a cache manager instance.
MAPPER_GRANTED_GROUPS - Static variable in class org.keycloak.models.Constants
 
MAPPER_GRANTED_ROLES - Static variable in class org.keycloak.models.Constants
 
MaximumLengthPasswordPolicyProvider - Class in org.keycloak.policy
 
MaximumLengthPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.MaximumLengthPasswordPolicyProvider
 
MaximumLengthPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
MaximumLengthPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
maxResults(int) - Method in interface org.keycloak.events.admin.AdminEventQuery
Use for pagination
maxResults(int) - Method in interface org.keycloak.events.EventQuery
Maximum number of results to return.
MEMBER - Static variable in class org.keycloak.models.LDAPConstants
 
MEMBER_OF - Static variable in class org.keycloak.models.LDAPConstants
 
MESSAGE_BLANK - Static variable in class org.keycloak.validate.validators.NotBlankValidator
 
MESSAGE_CONFIG_INVALID_BOOLEAN_VALUE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
Generic error messages for config validations - invalid config value - boolean expected
MESSAGE_CONFIG_INVALID_NUMBER_VALUE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
Generic error messages for config validations - invalid config value - number expected
MESSAGE_CONFIG_INVALID_STRING_VALUE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
Generic error messages for config validations - invalid config value - string expected
MESSAGE_CONFIG_INVALID_VALUE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
Generic error messages for config validations - invalid config value
MESSAGE_CONFIG_MISSING_VALUE - Static variable in class org.keycloak.validate.validators.ValidatorConfigValidator
Generic error messages for config validations - missing config value
MESSAGE_ERROR_EMPTY - Static variable in class org.keycloak.validate.validators.NotEmptyValidator
 
MESSAGE_INVALID_DATE - Static variable in class org.keycloak.validate.validators.LocalDateValidator
 
MESSAGE_INVALID_EMAIL - Static variable in class org.keycloak.validate.validators.EmailValidator
 
MESSAGE_INVALID_FRAGMENT - Static variable in class org.keycloak.validate.validators.UriValidator
 
MESSAGE_INVALID_LENGTH - Static variable in class org.keycloak.validate.validators.LengthValidator
 
MESSAGE_INVALID_LENGTH_TOO_LONG - Static variable in class org.keycloak.validate.validators.LengthValidator
 
MESSAGE_INVALID_LENGTH_TOO_SHORT - Static variable in class org.keycloak.validate.validators.LengthValidator
 
MESSAGE_INVALID_NUMBER - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
MESSAGE_INVALID_SCHEME - Static variable in class org.keycloak.validate.validators.UriValidator
 
MESSAGE_INVALID_URI - Static variable in class org.keycloak.validate.validators.UriValidator
 
MESSAGE_INVALID_VALUE - Static variable in class org.keycloak.validate.ValidationError
A generic invalid value message.
MESSAGE_NO_MATCH - Static variable in class org.keycloak.validate.validators.PatternValidator
 
MESSAGE_NUMBER_OUT_OF_RANGE - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
MESSAGE_NUMBER_OUT_OF_RANGE_TOO_BIG - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
MESSAGE_NUMBER_OUT_OF_RANGE_TOO_SMALL - Static variable in class org.keycloak.validate.validators.AbstractNumberValidator
 
metadata - Variable in class org.keycloak.userprofile.DefaultUserProfile
 
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) - Method in interface org.keycloak.migration.migrators.Migration
 
migrateFlows(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
migrateImport(KeycloakSession, RealmModel, RealmRepresentation, boolean) - Method in interface org.keycloak.migration.migrators.Migration
Called after full import of representation.
migrateOldOfflineToken(KeycloakSession, RealmModel, ClientModel, UserModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
Migration - Interface in org.keycloak.migration.migrators
 
MigrationProvider - Interface in org.keycloak.migration
Various common utils needed for migration from older version to newer
MigrationProviderFactory - Interface in org.keycloak.migration
 
MigrationSpi - Class in org.keycloak.migration
 
MigrationSpi() - Constructor for class org.keycloak.migration.MigrationSpi
 
MigrationUtils - Class in org.keycloak.migration.migrators
 
MigrationUtils() - Constructor for class org.keycloak.migration.migrators.MigrationUtils
 
MINIMUM_LOA - Static variable in class org.keycloak.models.Constants
 
MISSING_REQUIRED_DESTINATION - Static variable in interface org.keycloak.events.Errors
 
ModelToRepresentation - Class in org.keycloak.models.utils
 
ModelToRepresentation() - Constructor for class org.keycloak.models.utils.ModelToRepresentation
 
ModelVersion - Class in org.keycloak.migration
 
ModelVersion(int, int, int) - Constructor for class org.keycloak.migration.ModelVersion
 
ModelVersion(String) - Constructor for class org.keycloak.migration.ModelVersion
 
MODIFY_TIMESTAMP - Static variable in class org.keycloak.models.LDAPConstants
 
MSAD_USER_ACCOUNT_CONTROL_MAPPER - Static variable in class org.keycloak.models.LDAPConstants
 
MSADLDS_USER_ACCOUNT_CONTROL_MAPPER - Static variable in class org.keycloak.models.LDAPConstants
 
MSDS_USER_ACCOUNT_DISABLED - Static variable in class org.keycloak.models.LDAPConstants
 
MSDS_USER_PASSWORD_EXPIRED - Static variable in class org.keycloak.models.LDAPConstants
 
MSDS_USER_PASSWORD_NOTREQD - Static variable in class org.keycloak.models.LDAPConstants
 

N

name(String) - Method in class org.keycloak.provider.KeycloakDeploymentInfo
 
NAME - org.keycloak.authorization.model.Policy.FilterOption
 
NAME - org.keycloak.authorization.model.Resource.FilterOption
 
NAME - org.keycloak.authorization.model.Scope.FilterOption
 
NAME - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
NAME - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
NAME - Static variable in class org.keycloak.authorization.model.Scope.SearchableFields
 
NAME - Static variable in class org.keycloak.authorization.store.StoreFactorySpi
 
NAME - Static variable in class org.keycloak.component.ComponentFactorySpi
 
NAME - Static variable in class org.keycloak.events.EventStoreSpi
 
NAME - Static variable in class org.keycloak.models.ClaimMask
 
NAME - Static variable in class org.keycloak.models.DeploymentStateSpi
 
NAME - Static variable in class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
NAME - Static variable in class org.keycloak.models.SingleUseObjectSpi
 
NAME - Static variable in class org.keycloak.models.UserLoginFailureSpi
 
NAME - Static variable in class org.keycloak.models.UserSessionSpi
 
NamedPropertyCriteria - Class in org.keycloak.models.utils.reflection
A criteria that matches a property based on name
NamedPropertyCriteria(String...) - Constructor for class org.keycloak.models.utils.reflection.NamedPropertyCriteria
 
nameSet() - Method in interface org.keycloak.userprofile.Attributes
Returns the names of all defined attributes.
nameSet() - Method in class org.keycloak.userprofile.DefaultAttributes
 
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
NO - org.keycloak.services.clientpolicy.ClientPolicyVote
 
NO_LOA - Static variable in class org.keycloak.models.Constants
 
NODE_HOST - Static variable in interface org.keycloak.events.Details
 
NoLockingDBLockProviderFactory - Class in org.keycloak.models.dblock
 
NoLockingDBLockProviderFactory() - Constructor for class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
normalizeGroupPath(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
NOT_ALLOWED - Static variable in interface org.keycloak.events.Errors
 
NOT_LOGGED_IN - Static variable in interface org.keycloak.events.Errors
 
NOT_SUPPORTED - org.keycloak.authentication.InitiatedActionSupport
 
notBlankValidator() - Static method in class org.keycloak.validate.Validators
 
NotBlankValidator - Class in org.keycloak.validate.validators
Validate that value exists and is not empty nor blank.
NotBlankValidator() - Constructor for class org.keycloak.validate.validators.NotBlankValidator
 
NotEmailPasswordPolicyProvider - Class in org.keycloak.policy
A PasswordPolicyProvider which does not allow to use the current email as password.
NotEmailPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.NotEmailPasswordPolicyProvider
 
NotEmailPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
NotEmailPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
notEmptyValidator() - Static method in class org.keycloak.validate.Validators
 
NotEmptyValidator - Class in org.keycloak.validate.validators
Check that input value is not empty.
NotEmptyValidator() - Constructor for class org.keycloak.validate.validators.NotEmptyValidator
 
notExecuted() - Static method in class org.keycloak.cluster.ExecutionResult
 
notify(String, ClusterEvent, boolean, ClusterProvider.DCNotify) - Method in interface org.keycloak.cluster.ClusterProvider
Deprecated.
Notify registered listeners on all cluster nodes in all datacenters.
notifyCreated(KeycloakSession, RealmModel, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
notifyPreRemove(KeycloakSession, RealmModel, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
notifyUpdated(KeycloakSession, RealmModel, ComponentModel, ComponentModel) - Static method in class org.keycloak.models.utils.ComponentUtil
 
NotUsernamePasswordPolicyProvider - Class in org.keycloak.policy
 
NotUsernamePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
NotUsernamePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
NotUsernamePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
NOVELL_EDIRECTORY_GUID - Static variable in class org.keycloak.models.LDAPConstants
 

O

OAUTH_GRANT - org.keycloak.forms.login.LoginFormsPages
 
OAUTH2_DEVICE_AUTH - org.keycloak.events.EventType
 
OAUTH2_DEVICE_AUTH_ERROR - org.keycloak.events.EventType
 
OAUTH2_DEVICE_CODE_TO_TOKEN - org.keycloak.events.EventType
 
OAUTH2_DEVICE_CODE_TO_TOKEN_ERROR - org.keycloak.events.EventType
 
OAUTH2_DEVICE_VERIFY_USER_CODE - org.keycloak.events.EventType
 
OAUTH2_DEVICE_VERIFY_USER_CODE_ERROR - org.keycloak.events.EventType
 
OAuth2DeviceCodeModel - Class in org.keycloak.models
 
OAuth2DeviceUserCodeModel - Class in org.keycloak.models
 
OAuth2DeviceUserCodeModel(RealmModel, String, String) - Constructor for class org.keycloak.models.OAuth2DeviceUserCodeModel
 
OAuth2DeviceUserCodeProvider - Interface in org.keycloak.models
 
OAuth2DeviceUserCodeProviderFactory - Interface in org.keycloak.models
 
OAuth2DeviceUserCodeSpi - Class in org.keycloak.models
 
OAuth2DeviceUserCodeSpi() - Constructor for class org.keycloak.models.OAuth2DeviceUserCodeSpi
 
OBJECT_CLASS - Static variable in class org.keycloak.models.LDAPConstants
 
OBJECT_GUID - Static variable in class org.keycloak.models.LDAPConstants
 
OCSP_CONNECT_TIMEOUT - Static variable in class org.keycloak.utils.OCSPProvider
 
OCSPProvider - Class in org.keycloak.utils
 
OCSPProvider() - Constructor for class org.keycloak.utils.OCSPProvider
 
OCSPProvider.OCSPRevocationStatus - Interface in org.keycloak.utils
 
OCSPProvider.RevocationStatus - Enum in org.keycloak.utils
 
OFFLINE_ACCESS_ROLE - Static variable in class org.keycloak.models.Constants
 
OFFLINE_ACCESS_SCOPE_CONSENT_TEXT - Static variable in class org.keycloak.models.Constants
 
OFFLINE_SESSIONS - org.keycloak.models.dblock.DBLockProvider.Namespace
 
OfflineUserSessionModel - Interface in org.keycloak.models
Hacked extension to UserSessionModel so that user id can be obtain directly so
OIDC - Static variable in class org.keycloak.models.utils.RepresentationToModel
 
OIDCConfigAttributes - Class in org.keycloak.protocol.oidc
 
OIDCContext(ValidationContext.Event, KeycloakSession, ClientModel, OIDCClientRepresentation) - Constructor for class org.keycloak.validation.ClientValidationContext.OIDCContext
 
OK - Static variable in class org.keycloak.validate.ValidationResult
An empty ValidationResult that's valid by default.
onChange(String, UserModel, List<String>) - Method in interface org.keycloak.userprofile.AttributeChangeListener
Method called for each user attribute change.
onComplete() - Method in interface org.keycloak.authorization.Decision
 
onComplete() - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
onComplete() - Method in class org.keycloak.authorization.policy.evaluation.PermissionTicketAwareDecisionResultCollector
 
onComplete(Collection<Result>) - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
onComplete(ResourcePermission) - Method in interface org.keycloak.authorization.Decision
 
onComplete(ResourcePermission) - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
onComplete(Result) - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
onComplete(Result) - Method in class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
onCreate(Policy, R, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.OnCreateComponent
 
onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
Called when RoleStorageProviderModel is created.
OnCreateComponent - Interface in org.keycloak.storage
Callback for component creation.
onDecision(D) - Method in interface org.keycloak.authorization.Decision
 
onDecision(DefaultEvaluation) - Method in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
onError(Throwable) - Method in interface org.keycloak.authorization.Decision
 
onError(Throwable) - Method in class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
onError(ValidationResult) - Method in interface org.keycloak.validation.ValidationUtil.ErrorHandler
 
onEvent(AdminEvent, boolean) - Method in interface org.keycloak.events.EventListenerProvider
Called when an admin event occurs e.g.
onEvent(Event) - Method in interface org.keycloak.events.EventListenerProvider
Called when a user event occurs e.g.
onEvent(ProviderEvent) - Method in class org.keycloak.broker.provider.mappersync.ConfigSyncEventListener
 
onExport(Policy, PolicyRepresentation, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
onGrant(Permission) - Method in class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
onGrant(Permission) - Method in class org.keycloak.authorization.policy.evaluation.PermissionTicketAwareDecisionResultCollector
 
onImport(Policy, PolicyRepresentation, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
onParentFlowSuccess(AuthenticationFlowContext) - Method in interface org.keycloak.authentication.AuthenticationFlowCallback
Triggered after the authentication flow is successfully finished.
onRemove(Policy, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
onTopFlowSuccess() - Method in interface org.keycloak.authentication.AuthenticationFlowCallback
Triggered after the top authentication flow is successfully finished.
onUpdate(Policy, R, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
onUpdate(KeycloakSession, RealmModel, ComponentModel, ComponentModel) - Method in interface org.keycloak.component.AmphibianProviderFactory
 
onUpdate(KeycloakSession, RealmModel, ComponentModel, ComponentModel) - Method in interface org.keycloak.storage.OnUpdateComponent
 
OnUpdateComponent - Interface in org.keycloak.storage
Callback for component update.
operation(OperationType...) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by operation type
OPERATION_TYPE - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
OperationType - Enum in org.keycloak.events.admin
 
options() - Method in interface org.keycloak.headers.SecurityHeadersProvider
 
optionsValidator() - Static method in class org.keycloak.validate.Validators
 
OptionsValidator - Class in org.keycloak.validate.validators
Validation against list of allowed values - accepts plain string and collection of strings (every value is validated against allowed values), for basic behavior like null/blank values handling and collections support see AbstractStringValidator.
OptionsValidator() - Constructor for class org.keycloak.validate.validators.OptionsValidator
 
orderByAscTime() - Method in interface org.keycloak.events.admin.AdminEventQuery
Order the result by ascending time
orderByAscTime() - Method in interface org.keycloak.events.EventQuery
Order the result by ascending time
orderByDescTime() - Method in interface org.keycloak.events.admin.AdminEventQuery
Order the result by descending time
orderByDescTime() - Method in interface org.keycloak.events.EventQuery
Order the result by descending time
org.keycloak - package org.keycloak
 
org.keycloak.authentication - package org.keycloak.authentication
 
org.keycloak.authentication.otp - package org.keycloak.authentication.otp
 
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.mappersync - package org.keycloak.broker.provider.mappersync
 
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.component - package org.keycloak.component
 
org.keycloak.connections.httpclient - package org.keycloak.connections.httpclient
 
org.keycloak.credential - package org.keycloak.credential
 
org.keycloak.credential.hash - package org.keycloak.credential.hash
 
org.keycloak.crypto - package org.keycloak.crypto
 
org.keycloak.device - package org.keycloak.device
 
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.executors - package org.keycloak.executors
 
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.headers - package org.keycloak.headers
 
org.keycloak.keys - package org.keycloak.keys
 
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.authorization - package org.keycloak.models.cache.authorization
 
org.keycloak.models.dblock - package org.keycloak.models.dblock
 
org.keycloak.models.delegate - package org.keycloak.models.delegate
 
org.keycloak.models.utils - package org.keycloak.models.utils
 
org.keycloak.models.utils.reflection - package org.keycloak.models.utils.reflection
 
org.keycloak.policy - package org.keycloak.policy
 
org.keycloak.protocol - package org.keycloak.protocol
 
org.keycloak.protocol.oidc - package org.keycloak.protocol.oidc
 
org.keycloak.protocol.saml - package org.keycloak.protocol.saml
 
org.keycloak.protocol.saml.util - package org.keycloak.protocol.saml.util
 
org.keycloak.provider - package org.keycloak.provider
 
org.keycloak.scripting - package org.keycloak.scripting
 
org.keycloak.services.clientpolicy - package org.keycloak.services.clientpolicy
 
org.keycloak.services.clientpolicy.condition - package org.keycloak.services.clientpolicy.condition
 
org.keycloak.services.clientpolicy.executor - package org.keycloak.services.clientpolicy.executor
 
org.keycloak.services.managers - package org.keycloak.services.managers
 
org.keycloak.services.resource - package org.keycloak.services.resource
 
org.keycloak.services.scheduled - package org.keycloak.services.scheduled
 
org.keycloak.sessions - package org.keycloak.sessions
 
org.keycloak.storage - package org.keycloak.storage
 
org.keycloak.storage.adapter - package org.keycloak.storage.adapter
 
org.keycloak.storage.role - package org.keycloak.storage.role
 
org.keycloak.theme - package org.keycloak.theme
 
org.keycloak.timer - package org.keycloak.timer
 
org.keycloak.transaction - package org.keycloak.transaction
 
org.keycloak.truststore - package org.keycloak.truststore
 
org.keycloak.userprofile - package org.keycloak.userprofile
 
org.keycloak.utils - package org.keycloak.utils
 
org.keycloak.validate - package org.keycloak.validate
 
org.keycloak.validate.validators - package org.keycloak.validate.validators
 
org.keycloak.validation - package org.keycloak.validation
 
OTPApplicationProvider - Interface in org.keycloak.authentication.otp
 
OTPApplicationProviderFactory - Interface in org.keycloak.authentication.otp
 
OTPApplicationSpi - Class in org.keycloak.authentication.otp
 
OTPApplicationSpi() - Constructor for class org.keycloak.authentication.otp.OTPApplicationSpi
 
OVERWRITE_EXISTING - org.keycloak.exportimport.Strategy
 
OWNER - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
OWNER - org.keycloak.authorization.model.Policy.FilterOption
 
OWNER - org.keycloak.authorization.model.Resource.FilterOption
 
OWNER - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
OWNER - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
OWNER - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
OWNER_MANAGED_ACCESS - org.keycloak.authorization.model.Resource.FilterOption
 
OWNER_MANAGED_ACCESS - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 

P

paginatedStream(Stream<T>, Integer, Integer) - Static method in class org.keycloak.utils.StreamsUtil
Returns the original stream that is limited with skip and limit functions based on values of first and max parameters.
PAGINATION - Static variable in class org.keycloak.models.LDAPConstants
 
param(String, String) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
Params() - Constructor for class org.keycloak.protocol.oidc.TokenExchangeContext.Params
 
parseConfig(String) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
parseConfig(String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
parseConfig(String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
parseConfig(KeycloakSession, InputStream) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
parseConfig(KeycloakSession, InputStream) - Method in interface org.keycloak.broker.provider.IdentityProviderFactory
Creates an IdentityProvider based on the configuration from inputStream.
parseRole(String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
PASSIVE_INTERACTION_REQUIRED - org.keycloak.protocol.LoginProtocol.Error
Passive authentication mode requested, user is logged in, but some other user interaction is necessary (eg.
PASSIVE_LOGIN_REQUIRED - org.keycloak.protocol.LoginProtocol.Error
Passive authentication mode requested but nobody is logged in
PASSWORD - org.keycloak.forms.account.AccountPages
 
PASSWORD_BLACKLISTS_FOLDER - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
PASSWORD_CONFIRM_ERROR - Static variable in interface org.keycloak.events.Errors
 
PASSWORD_MISSING - Static variable in interface org.keycloak.events.Errors
 
PASSWORD_REJECTED - Static variable in interface org.keycloak.events.Errors
 
PasswordHashProviderFactory - Interface in org.keycloak.credential.hash
 
PasswordHashSpi - Class in org.keycloak.credential.hash
 
PasswordHashSpi() - Constructor for class org.keycloak.credential.hash.PasswordHashSpi
 
PasswordPolicyManagerProvider - Interface in org.keycloak.policy
 
PasswordPolicyManagerProviderFactory - Interface in org.keycloak.policy
 
PasswordPolicyManagerSpi - Class in org.keycloak.policy
 
PasswordPolicyManagerSpi() - Constructor for class org.keycloak.policy.PasswordPolicyManagerSpi
 
PasswordPolicyProviderFactory - Interface in org.keycloak.policy
 
PasswordPolicySpi - Class in org.keycloak.policy
 
PasswordPolicySpi() - Constructor for class org.keycloak.policy.PasswordPolicySpi
 
patternValidator() - Static method in class org.keycloak.validate.Validators
 
PatternValidator - Class in org.keycloak.validate.validators
Validate String against configured RegEx pattern - accepts plain string and collection of strings, for basic behavior like null/blank values handling and collections support see AbstractStringValidator.
PatternValidator() - Constructor for class org.keycloak.validate.validators.PatternValidator
 
PBKDF2_ALGORITHM - Static variable in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
PBKDF2_ALGORITHM - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
PBKDF2_ALGORITHM - Static variable in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
Pbkdf2PasswordHashProvider - Class in org.keycloak.credential.hash
 
Pbkdf2PasswordHashProvider(String, String, int) - Constructor for class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
Pbkdf2PasswordHashProvider(String, String, int, int) - Constructor for class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
Pbkdf2PasswordHashProviderFactory - Class in org.keycloak.credential.hash
 
Pbkdf2PasswordHashProviderFactory() - Constructor for class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
Pbkdf2Sha256PasswordHashProviderFactory - Class in org.keycloak.credential.hash
PBKDF2 Password Hash provider with HMAC using SHA256
Pbkdf2Sha256PasswordHashProviderFactory() - Constructor for class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
Pbkdf2Sha512PasswordHashProviderFactory - Class in org.keycloak.credential.hash
Provider factory for SHA512 variant of the PBKDF2 password hash algorithm.
Pbkdf2Sha512PasswordHashProviderFactory() - Constructor for class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
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.
PERIODIC_CLEANER_IDLE_TIMEOUT_WINDOW_SECONDS - Static variable in class org.keycloak.models.utils.SessionTimeoutHelper
The maximum time difference, which will be still tolerated when checking userSession idle timeout with periodic cleaner threads.
PERIODIC_TASK_INTERVAL_SECONDS - Static variable in class org.keycloak.models.utils.SessionTimeoutHelper
Interval specifies maximum time, for which the "userSession.lastSessionRefresh" may contain stale value.
permission(ResourceServer, Resource, Scope) - Static method in class org.keycloak.authorization.permission.Permissions
 
PERMISSION - org.keycloak.authorization.model.Policy.FilterOption
 
PERMISSION - Static variable in interface org.keycloak.events.Details
 
PERMISSION_TOKEN - org.keycloak.events.EventType
 
PERMISSION_TOKEN_ERROR - org.keycloak.events.EventType
 
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.
Permissions - Class in org.keycloak.authorization.permission
 
Permissions() - Constructor for class org.keycloak.authorization.permission.Permissions
 
PermissionTicket - Interface in org.keycloak.authorization.model
 
PermissionTicket.FilterOption - Enum in org.keycloak.authorization.model
 
PermissionTicket.SearchableFields - Class in org.keycloak.authorization.model
 
PermissionTicketAwareDecisionResultCollector - Class in org.keycloak.authorization.policy.evaluation
 
PermissionTicketAwareDecisionResultCollector(AuthorizationRequest, PermissionTicketToken, Identity, ResourceServer, AuthorizationProvider) - Constructor for class org.keycloak.authorization.policy.evaluation.PermissionTicketAwareDecisionResultCollector
 
PermissionTicketStore - Interface in org.keycloak.authorization.store
A PermissionTicketStore is responsible to manage the persistence of PermissionTicket instances.
PERMIT - org.keycloak.authorization.Decision.Effect
 
PHONE - Static variable in class org.keycloak.models.ClaimMask
 
PICTURE - Static variable in class org.keycloak.models.ClaimMask
 
PKCE_CODE_CHALLENGE_METHOD - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
PKCE_VERIFICATION_FAILED - Static variable in interface org.keycloak.events.Errors
 
policy(Policy) - Method in class org.keycloak.authorization.policy.evaluation.Result
 
policy(Policy, Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
Policy - Interface in org.keycloak.authorization.model
Represents an authorization policy and all the configuration associated with it.
POLICY_ID - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
POLICY_ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
POLICY_IS_NOT_NULL - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
Policy.FilterOption - Enum in org.keycloak.authorization.model
 
Policy.SearchableFields - Class in org.keycloak.authorization.model
 
policyCheck(PasswordPolicy, PasswordCredentialModel) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
PolicyEvaluator - Interface in org.keycloak.authorization.policy.evaluation
A PolicyEvaluator evaluates authorization policies based on a given ResourcePermission, sending the results to a Decision point through the methods defined in that interface.
PolicyProvider - Interface in org.keycloak.authorization.policy.provider
 
PolicyProviderAdminService<R extends AbstractPolicyRepresentation> - Interface in org.keycloak.authorization.policy.provider
 
PolicyProviderFactory<R extends AbstractPolicyRepresentation> - Interface in org.keycloak.authorization.policy.provider
 
PolicyResult(Policy) - Constructor for class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
PolicyResult(Policy, Decision.Effect) - 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.
POST_LOGOUT_REDIRECT_URIS - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
POSTAL_CODE - Static variable in class org.keycloak.models.LDAPConstants
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.authentication.otp.OTPApplicationProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.AuthorizationStoreFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.credential.CredentialProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.crypto.CekManagementProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.crypto.ClientSignatureVerifierProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.crypto.ContentEncryptionProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.crypto.HashProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.crypto.SignatureProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.headers.SecurityHeadersProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.keys.KeyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.models.DefaultOAuth2DeviceUserCodeProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.DigitsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.HistoryPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.LengthPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.protocol.AbstractLoginProtocolFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.provider.ExceptionConverter
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProviderFactory
 
postInit(KeycloakSessionFactory) - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.validate.SimpleValidator
 
postInit(KeycloakSessionFactory) - Method in interface org.keycloak.validation.ClientValidationProviderFactory
 
PostMigrationEvent - Class in org.keycloak.models.utils
Executed at startup after model migration is finished
PostMigrationEvent(KeycloakSessionFactory) - Constructor for class org.keycloak.models.utils.PostMigrationEvent
 
postText(String, String) - Method in interface org.keycloak.connections.httpclient.HttpClientProvider
Helper method
PREF_PREVIOUS - Static variable in interface org.keycloak.events.Details
 
PREF_UPDATED - Static variable in interface org.keycloak.events.Details
 
prepareEvaluatableScript(ScriptModel) - Method in interface org.keycloak.scripting.ScriptingProvider
Returns an EvaluatableScriptAdapter based on the given ScriptModel.
prepareInvocableScript(ScriptModel, ScriptBindingsConfigurer) - Method in interface org.keycloak.scripting.ScriptingProvider
Returns an InvocableScriptAdapter based on the given ScriptModel.
preprocessFederatedIdentity(KeycloakSession, RealmModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProvider
 
preprocessFederatedIdentity(KeycloakSession, RealmModel, BrokeredIdentityContext) - Method in interface org.keycloak.broker.provider.IdentityProvider
 
preprocessFederatedIdentity(KeycloakSession, RealmModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
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(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.AmphibianProviderFactory
 
PREVIOUS_EMAIL - Static variable in interface org.keycloak.events.Details
 
PREVIOUS_FIRST_NAME - Static variable in interface org.keycloak.events.Details
 
PREVIOUS_LAST_NAME - Static variable in interface org.keycloak.events.Details
 
processAction(String) - Method in interface org.keycloak.authentication.AuthenticationFlow
 
processAction(RequiredActionContext) - Method in interface org.keycloak.authentication.RequiredActionProvider
Called when a required action has form input you want to process.
processFlow() - Method in interface org.keycloak.authentication.AuthenticationFlow
 
PROFILE - Static variable in class org.keycloak.models.ClaimMask
 
Properties - Class in org.keycloak.models.utils.reflection
Utility class for working with JavaBean style properties
Property<V> - Interface in org.keycloak.models.utils.reflection
A representation of a JavaBean style property
PropertyCriteria - Interface in org.keycloak.models.utils.reflection
A property criteria can be used to filter the properties found by a PropertyQuery
PropertyQueries - Class in org.keycloak.models.utils.reflection
Utilities for working with property queries
PropertyQuery<V> - Class in org.keycloak.models.utils.reflection
Queries a target class for properties that match certain criteria.
PROTOCOL_MAPPER - org.keycloak.events.admin.ResourceType
 
ProtocolMapper - Interface in org.keycloak.protocol
 
ProtocolMapperConfigException - Exception in org.keycloak.protocol
 
ProtocolMapperConfigException(String) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, Object...) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String, Object...) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, String, Throwable) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperConfigException(String, Throwable) - Constructor for exception org.keycloak.protocol.ProtocolMapperConfigException
 
ProtocolMapperSpi - Class in org.keycloak.protocol
 
ProtocolMapperSpi() - Constructor for class org.keycloak.protocol.ProtocolMapperSpi
 
PROVIDER_ID - Static variable in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
PROVIDER_ID - Static variable in class org.keycloak.sessions.AuthenticationSessionSpi
 
ProviderLoader - Interface in org.keycloak.provider
 
ProviderLoaderFactory - Interface in org.keycloak.provider
 
ProxyClassLoader - Class in org.keycloak.utils
 
ProxyClassLoader(ClassLoader...) - Constructor for class org.keycloak.utils.ProxyClassLoader
Init classloader with the list of given delegates
ProxyClassLoader(Collection<Class<?>>) - Constructor for class org.keycloak.utils.ProxyClassLoader
Get all unique classloaders from the provided classes to be used as "Delegate classloaders"
PublicKeyLoader - Interface in org.keycloak.keys
 
PublicKeyStorageProvider - Interface in org.keycloak.keys
 
PublicKeyStorageProviderFactory<T extends PublicKeyStorageProvider> - Interface in org.keycloak.keys
 
PublicKeyStorageSpi - Class in org.keycloak.keys
 
PublicKeyStorageSpi() - Constructor for class org.keycloak.keys.PublicKeyStorageSpi
 
PublicKeyStorageUtils - Class in org.keycloak.keys
 
PublicKeyStorageUtils() - Constructor for class org.keycloak.keys.PublicKeyStorageUtils
 
PUSHED_AUTHORIZATION_REQUEST - org.keycloak.events.EventType
 
PUSHED_AUTHORIZATION_REQUEST_ERROR - org.keycloak.events.EventType
 
put(String, long, Map<String, String>) - Method in interface org.keycloak.models.SingleUseObjectProvider
Stores the given data and guarantees that data should be available in the store for at least the time specified by {@param lifespanSeconds} parameter
putConfig(String, String) - Method in interface org.keycloak.authorization.model.Policy
 
putIfAbsent(String, long) - Method in interface org.keycloak.models.SingleUseObjectProvider
Will try to put the key into the cache.
PWD_LAST_SET - Static variable in class org.keycloak.models.LDAPConstants
 

Q

QUERY_CLIENTS - Static variable in class org.keycloak.models.AdminRoles
 
QUERY_GROUPS - Static variable in class org.keycloak.models.AdminRoles
 
QUERY_REALMS - Static variable in class org.keycloak.models.AdminRoles
 
QUERY_USERS - Static variable in class org.keycloak.models.AdminRoles
 

R

RDN_LDAP_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 
READ_ONLY_ATTRIBUTE_KEY - Static variable in class org.keycloak.userprofile.DefaultAttributes
To reference dynamic attributes that can be configured as read-only when setting up the provider.
READ_TIMEOUT - Static variable in class org.keycloak.models.LDAPConstants
 
READ_TOKEN_ROLE - Static variable in class org.keycloak.models.Constants
 
ReadOnlyUserModelDelegate - Class in org.keycloak.models.utils
 
ReadOnlyUserModelDelegate(UserModel) - Constructor for class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
ReadOnlyUserModelDelegate(UserModel, Function<String, RuntimeException>) - Constructor for class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
realm(String) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by resource realm
realm(String) - Method in class org.keycloak.events.EventBuilder
 
realm(String) - Method in interface org.keycloak.events.EventQuery
Search events within realm
realm(RealmModel) - Method in class org.keycloak.events.EventBuilder
 
Realm - Interface in org.keycloak.authorization.policy.evaluation
This interface provides methods to query information from a realm.
REALM - org.keycloak.events.admin.ResourceType
 
REALM_ADMIN - Static variable in class org.keycloak.models.AdminRoles
 
REALM_ATTR_USERNAME_CASE_SENSITIVE - Static variable in class org.keycloak.models.Constants
 
REALM_ATTR_USERNAME_CASE_SENSITIVE_DEFAULT - Static variable in class org.keycloak.models.Constants
 
REALM_DISABLED - Static variable in interface org.keycloak.events.Errors
 
REALM_EXCLUDED_ATTRIBUTES - Static variable in class org.keycloak.models.utils.ModelToRepresentation
 
REALM_FILE - org.keycloak.exportimport.UsersExportStrategy
 
REALM_ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.authorization.model.ResourceServer.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.authorization.model.Scope.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
REALM_ID - Static variable in class org.keycloak.events.Event.SearchableFields
 
REALM_MANAGEMENT_CLIENT_ID - Static variable in class org.keycloak.models.Constants
 
REALM_ROLE - org.keycloak.events.admin.ResourceType
 
REALM_ROLE_MAPPING - org.keycloak.events.admin.ResourceType
 
REALM_SCOPE_MAPPING - org.keycloak.events.admin.ResourceType
 
realmDefaultHeaders - Static variable in enum org.keycloak.models.BrowserSecurityHeaders
Deprecated.
RealmProviderFactory<T extends RealmProvider> - 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.storage.DatastoreProvider
 
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
 
RecoveryCodesWarningThresholdPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
RecoveryCodesWarningThresholdPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
REDIRECT_URI - Static variable in interface org.keycloak.events.Details
 
REFERRER_POLICY - org.keycloak.models.BrowserSecurityHeaders
 
REFRESH_TOKEN - org.keycloak.events.EventType
 
REFRESH_TOKEN_ERROR - org.keycloak.events.EventType
 
REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
REFRESH_TOKEN_TYPE - Static variable in interface org.keycloak.events.Details
 
RegexPatternsPasswordPolicyProvider - Class in org.keycloak.policy
 
RegexPatternsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
RegexPatternsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
RegexPatternsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory
 
REGISTER - org.keycloak.events.EventType
 
REGISTER - org.keycloak.forms.login.LoginFormsPages
 
REGISTER_ERROR - org.keycloak.events.EventType
 
REGISTER_METHOD - Static variable in interface org.keycloak.events.Details
 
REGISTER_NODE - org.keycloak.events.EventType
 
REGISTER_NODE_ERROR - org.keycloak.events.EventType
 
REGISTER_USER_PROFILE - org.keycloak.forms.login.LoginFormsPages
 
registerListener(String, ClusterListener) - Method in interface org.keycloak.cluster.ClusterProvider
Deprecated.
Register task (listener) under given key.
registerNode(String, int) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
registerSynchronizationListeners(KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.AuthorizationStoreFactory
 
REGISTRATION_DISABLED - Static variable in interface org.keycloak.events.Errors
 
REGISTRATION_DISABLED - Static variable in interface org.keycloak.forms.login.LoginFormsProvider
 
REGISTRATION_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
REGISTRATION_FORM_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
REGISTRATION_PROFILE - org.keycloak.userprofile.UserProfileContext
 
REGISTRATION_USER_CREATION - org.keycloak.userprofile.UserProfileContext
 
registrationFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
REJECTED_BY_USER - Static variable in interface org.keycloak.events.Errors
 
releaseLock() - Method in interface org.keycloak.models.dblock.DBLockProvider
Release previously acquired lock by this provider.
REMEMBER_ME - Static variable in interface org.keycloak.events.Details
 
remove(String) - Method in interface org.keycloak.models.SingleUseObjectProvider
This method returns data just if removal was successful.
REMOVE_FEDERATED_IDENTITY - org.keycloak.events.EventType
 
REMOVE_FEDERATED_IDENTITY_ERROR - org.keycloak.events.EventType
 
REMOVE_TOTP - org.keycloak.events.EventType
 
REMOVE_TOTP_ERROR - org.keycloak.events.EventType
 
removeAssociatedPolicy(Policy) - Method in interface org.keycloak.authorization.model.Policy
 
removeAttribute(String) - Method in interface org.keycloak.authorization.model.Resource
 
removeAttribute(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeAttribute(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
removeAttribute(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
removeAuthenticationFlowBindingOverride(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeClaim(String) - Method in class org.keycloak.authorization.permission.ResourcePermission
Removes a permission claim.
removeClientScope(ClientScopeModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeConfig(String) - Method in interface org.keycloak.authorization.model.Policy
 
removeDefaultRoles(String...) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeDetail(String) - Method in class org.keycloak.events.EventBuilder
 
removeEmptyString(Map<String, String>) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
removePolicy(PermissionTicket, StoreFactory) - Static method in class org.keycloak.authorization.UserManagedPermissionUtil
 
removeProtocolMapper(ProtocolMapperModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeRedirectUri(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeRequiredAction(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
removeResource(Resource) - Method in interface org.keycloak.authorization.model.Policy
 
removeRole(RoleModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
removeScope(Scope) - Method in interface org.keycloak.authorization.model.Policy
 
removeUserAttribute(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
removeWebOrigin(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
render(FormContext, LoginFormsProvider) - Method in interface org.keycloak.authentication.FormAuthenticator
Called to render the FormAuthenticator's challenge page.
replace(String, Map<String, String>) - Method in interface org.keycloak.models.SingleUseObjectProvider
Replaces data associated with the given key in the store if the store contains the key.
RepresentationToModel - Class in org.keycloak.models.utils
 
RepresentationToModel() - Constructor for class org.keycloak.models.utils.RepresentationToModel
 
REQUEST_OBJECT_ENCRYPTION_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_ENCRYPTION_ENC - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_REQUIRED - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_REQUIRED_REQUEST - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_REQUIRED_REQUEST_OR_REQUEST_URI - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_REQUIRED_REQUEST_URI - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_OBJECT_SIGNATURE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUEST_URIS - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
REQUESTED_ISSUER - Static variable in interface org.keycloak.events.Details
 
REQUESTED_LEVEL_OF_AUTHENTICATION - Static variable in class org.keycloak.models.Constants
 
REQUESTED_SUBJECT - Static variable in interface org.keycloak.events.Details
 
REQUESTER - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
REQUESTER - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
REQUESTER_IS_NULL - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
REQUIRED_ACTION - org.keycloak.events.admin.ResourceType
 
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.KcActionStatus - Enum in org.keycloak.authentication
 
RequiredActionContext.Status - Enum in org.keycloak.authentication
 
RequiredActionFactory - Interface in org.keycloak.authentication
You must specify a file META-INF/services/org.keycloak.authentication.RequiredActionFactory in the jar that this class is contained in This file must have the fully qualified class name of all your RequiredActionFactory classes
RequiredActionProvider - Interface in org.keycloak.authentication
RequiredAction provider.
RequiredActionSpi - Class in org.keycloak.authentication
 
RequiredActionSpi() - Constructor for class org.keycloak.authentication.RequiredActionSpi
 
REQUIREMENT_CHOICES - Static variable in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory
 
requireReauthentication(UserSessionModel, AuthenticationSessionModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
requiresUser() - Method in interface org.keycloak.authentication.Authenticator
Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
requiresUser() - Method in interface org.keycloak.authentication.FormAction
Does this FormAction require that a user be set? For registration, this method will always return false.
RESET_CREDENTIAL_DISABLED - Static variable in interface org.keycloak.events.Errors
 
RESET_CREDENTIALS_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
RESET_PASSWORD - org.keycloak.events.EventType
 
RESET_PASSWORD_ERROR - org.keycloak.events.EventType
 
resetCredentialsFlow(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
resetEmailVerified - Variable in enum org.keycloak.userprofile.UserProfileContext
 
resetFlow() - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Reset the current flow to the beginning and restarts it.
resetFlow(Runnable) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Reset the current flow to the beginning and restarts it.
ResetTimeOffsetEvent - Class in org.keycloak.models.utils
Useful when there is a need for callback when time offset is restarted.
ResetTimeOffsetEvent() - Constructor for class org.keycloak.models.utils.ResetTimeOffsetEvent
 
RESOLVE_REQUIRED_ACTIONS - Static variable in interface org.keycloak.events.Errors
 
resolveArtifact(AuthenticatedClientSessionModel, String) - Method in interface org.keycloak.protocol.saml.ArtifactResolver
Returns a serialized Saml ArtifactResponse corresponding to the artifact that was created by buildArtifact
resolveAttribute(String) - Method in class org.keycloak.models.ClientConfigResolver
 
resolveAttribute(GroupModel, String, boolean) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolveAttribute(UserModel, String, boolean) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolveBrowserFlow(AuthenticationSessionModel) - Static method in class org.keycloak.models.utils.AuthenticationFlowResolver
 
resolveDirectGrantFlow(AuthenticationSessionModel) - Static method in class org.keycloak.models.utils.AuthenticationFlowResolver
 
resolveFirstAttribute(GroupModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
resolvePasswordBlacklist(String) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
Resolves and potentially registers a BlacklistPasswordPolicyProviderFactory.PasswordBlacklist for the given blacklistName.
resolveScopes(Resource, ResourceServer, Collection<Scope>, AuthorizationProvider) - Static method in class org.keycloak.authorization.permission.Permissions
 
Resource - Interface in org.keycloak.authorization.model
Represents a resource, which is usually protected by a set of policies within a resource server.
RESOURCE_DETAIL - org.keycloak.forms.account.AccountPages
 
RESOURCE_ID - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
RESOURCE_ID - org.keycloak.authorization.model.Policy.FilterOption
 
RESOURCE_ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
RESOURCE_ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
RESOURCE_NAME - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
RESOURCE_PATH - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
RESOURCE_SERVER_ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
RESOURCE_SERVER_ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
RESOURCE_SERVER_ID - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
RESOURCE_SERVER_ID - Static variable in class org.keycloak.authorization.model.Scope.SearchableFields
 
RESOURCE_TYPE - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
Resource.FilterOption - Enum in org.keycloak.authorization.model
 
Resource.SearchableFields - Class in org.keycloak.authorization.model
 
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, Collection<Scope>, ResourceServer) - Constructor for class org.keycloak.authorization.permission.ResourcePermission
 
ResourcePermission(Resource, Collection<Scope>, ResourceServer, Map<String, ? extends Collection<String>>) - Constructor for class org.keycloak.authorization.permission.ResourcePermission
 
ResourcePermission(Resource, ResourceServer, Map<String, ? extends Collection<String>>) - Constructor for class org.keycloak.authorization.permission.ResourcePermission
 
RESOURCES - org.keycloak.forms.account.AccountPages
 
ResourceServer - Interface in org.keycloak.authorization.model
Represents a resource server, whose resources are managed and protected.
ResourceServer.SearchableFields - Class in org.keycloak.authorization.model
 
ResourceServerStore - Interface in org.keycloak.authorization.store
A ResourceServerStore is responsible to manage the persistence of ResourceServer instances.
ResourceStore - Interface in org.keycloak.authorization.store
A ResourceStore is responsible to manage the persistence of Resource instances.
resourceType(ResourceType...) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by ResourceType.
ResourceType - Enum in org.keycloak.events.admin
Represents Keycloak resource types for which AdminEvent's can be triggered.
Response(HttpResponse) - Constructor for class org.keycloak.broker.provider.util.SimpleHttp.Response
 
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
 
RESTART_AUTHENTICATION - org.keycloak.events.EventType
 
RESTART_AUTHENTICATION_ERROR - org.keycloak.events.EventType
 
Result - Class in org.keycloak.authorization.policy.evaluation
 
Result(ResourcePermission, Evaluation) - Constructor for class org.keycloak.authorization.policy.evaluation.Result
 
Result.PolicyResult - Class in org.keycloak.authorization.policy.evaluation
 
results - Variable in class org.keycloak.authorization.policy.evaluation.AbstractDecisionCollector
 
results() - Method in class org.keycloak.authorization.policy.evaluation.DecisionPermissionCollector
 
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.
REVOKE_GRANT - org.keycloak.events.EventType
 
REVOKE_GRANT_ERROR - org.keycloak.events.EventType
 
REVOKED - org.keycloak.utils.OCSPProvider.RevocationStatus
 
REVOKED_CLIENT - Static variable in interface org.keycloak.events.Details
 
REVOKED_KEY - Static variable in interface org.keycloak.models.SingleUseObjectProvider
 
ROLE - Static variable in interface org.keycloak.broker.provider.ConfigConstants
 
RoleConfigPropertyByClientIdSynchronizer - Class in org.keycloak.broker.provider.mappersync
Updates a role reference in a mapper config, when a client ID changes.
RoleConfigPropertyByRoleNameSynchronizer - Class in org.keycloak.broker.provider.mappersync
Updates a role reference a in mapper config, when a role name changes.
RoleProviderFactory<T extends RoleProvider> - Interface in org.keycloak.models
 
roles() - Method in interface org.keycloak.storage.DatastoreProvider
 
RoleSpi - Class in org.keycloak.models
 
RoleSpi() - Constructor for class org.keycloak.models.RoleSpi
 
RoleStorageProviderFactory<T extends RoleStorageProvider> - Interface in org.keycloak.storage.role
 
RoleStorageProviderSpi - Class in org.keycloak.storage.role
 
RoleStorageProviderSpi() - Constructor for class org.keycloak.storage.role.RoleStorageProviderSpi
 
rollbackImpl() - Method in class org.keycloak.events.EventListenerTransaction
 
run() - Method in class org.keycloak.services.scheduled.ScheduledTaskRunner
 
run(KeycloakSession) - Method in interface org.keycloak.timer.ScheduledTask
 
runJobInRetriableTransaction(KeycloakSessionFactory, KeycloakSessionTaskWithResult<V>, int, int) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Creates a new KeycloakSession and runs the specified callable in a new transaction.
runJobInTransaction(KeycloakSessionFactory, KeycloakSessionTask) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Wrap given runnable job into KeycloakTransaction.
runJobInTransactionWithTimeout(KeycloakSessionFactory, KeycloakSessionTask, int) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Wrap given runnable job into KeycloakTransaction.
runTask(KeycloakSession) - Method in class org.keycloak.services.scheduled.ScheduledTaskRunner
 

S

SAM_ACCOUNT_NAME - Static variable in class org.keycloak.models.LDAPConstants
 
SAME_FILE - org.keycloak.exportimport.UsersExportStrategy
 
SAML_ECP_FLOW - Static variable in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
SAML_POST_FORM - org.keycloak.forms.login.LoginFormsPages
 
SAML_TOKEN_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
samlEcpProfile(RealmModel) - Static method in class org.keycloak.models.utils.DefaultAuthenticationFlows
 
schedule(Runnable, long, String) - Method in interface org.keycloak.timer.TimerProvider
 
ScheduledTask - Interface in org.keycloak.timer
 
ScheduledTaskRunner - Class in org.keycloak.services.scheduled
 
ScheduledTaskRunner(KeycloakSessionFactory, ScheduledTask) - Constructor for class org.keycloak.services.scheduled.ScheduledTaskRunner
 
ScheduledTaskRunner(KeycloakSessionFactory, ScheduledTask, int) - Constructor for class org.keycloak.services.scheduled.ScheduledTaskRunner
 
scheduleTask(ScheduledTask, long, String) - Method in interface org.keycloak.timer.TimerProvider
 
scope(String...) - Method in class org.keycloak.component.ComponentModelScope
 
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.
SCOPE - Static variable in interface org.keycloak.events.Details
 
SCOPE_ID - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
SCOPE_ID - org.keycloak.authorization.model.Policy.FilterOption
 
SCOPE_ID - org.keycloak.authorization.model.Resource.FilterOption
 
SCOPE_ID - Static variable in class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
SCOPE_ID - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
SCOPE_ID - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
SCOPE_IS_NULL - org.keycloak.authorization.model.PermissionTicket.FilterOption
 
Scope.FilterOption - Enum in org.keycloak.authorization.model
 
Scope.SearchableFields - Class in org.keycloak.authorization.model
 
ScopeStore - Interface in org.keycloak.authorization.store
A ScopeStore is responsible to manage the persistence of Scope instances.
Script - Class in org.keycloak.scripting
A ScriptModel which holds some meta-data.
Script(String, String, String, String, String, String) - Constructor for class org.keycloak.scripting.Script
 
ScriptBindingsConfigurer - Interface in org.keycloak.scripting
Callback interface for customization of Bindings for a ScriptEngine.
ScriptCompilationException - Exception in org.keycloak.scripting
Indicates compilation problems reported by a ScriptException and adds additional metadata.
ScriptCompilationException(ScriptModel, Exception) - Constructor for exception org.keycloak.scripting.ScriptCompilationException
 
ScriptExecutionException - Exception in org.keycloak.scripting
Augments a ScriptException and adds additional metadata.
ScriptExecutionException(ScriptModel, Exception) - Constructor for exception org.keycloak.scripting.ScriptExecutionException
 
ScriptingProvider - Interface in org.keycloak.scripting
A Provider than provides Scripting capabilities.
ScriptingProviderFactory - Interface in org.keycloak.scripting
 
ScriptingSpi - Class in org.keycloak.scripting
 
ScriptingSpi() - Constructor for class org.keycloak.scripting.ScriptingSpi
 
SEARCH_SCOPE - Static variable in class org.keycloak.models.LDAPConstants
 
SearchableFields() - Constructor for class org.keycloak.authorization.model.PermissionTicket.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.authorization.model.Policy.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.authorization.model.Resource.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.authorization.model.ResourceServer.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.authorization.model.Scope.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.events.admin.AdminEvent.SearchableFields
 
SearchableFields() - Constructor for class org.keycloak.events.Event.SearchableFields
 
searchFor(RoleModel, RoleModel, Set<String>) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Deep search if given role is descendant of composite role
searchForGroupByName(KeycloakSession, RealmModel, boolean, String, Boolean, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
searchForGroupByName(RealmModel, boolean, String, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
Deprecated.
searchForGroupByName(UserModel, boolean, String, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
searchForRolesStream(String, Integer, Integer) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
searchGroupsByAttributes(KeycloakSession, RealmModel, boolean, Map<String, String>, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
SecurityHeadersOptions - Interface in org.keycloak.headers
 
SecurityHeadersProvider - Interface in org.keycloak.headers
 
SecurityHeadersProviderFactory - Interface in org.keycloak.headers
 
SecurityHeadersSpi - Class in org.keycloak.headers
 
SecurityHeadersSpi() - Constructor for class org.keycloak.headers.SecurityHeadersSpi
 
SELECTED_CREDENTIAL_ID - Static variable in interface org.keycloak.events.Details
 
selectErrorMessage(ValidatorConfig) - Method in class org.keycloak.validate.validators.LengthValidator
Select error message depending on the allowed length interval bound configuration.
selectRangeErrorMessage(ValidatorConfig) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
Select error message depending on the allowed range interval bound configuration.
selectSourceClient(KeycloakSession, String) - Method in interface org.keycloak.protocol.saml.ArtifactResolver
Returns client model that issued artifact
send(String, String, Map<String, Object>) - Method in interface org.keycloak.email.EmailTemplateProvider
Send formatted email
send(String, List<Object>, String, Map<String, Object>) - Method in interface org.keycloak.email.EmailTemplateProvider
Send formatted email
send(Map<String, String>, String, String, String, String) - Method in interface org.keycloak.email.EmailSenderProvider
 
send(Map<String, String>, UserModel, String, String, String) - Method in interface org.keycloak.email.EmailSenderProvider
 
SEND_IDENTITY_PROVIDER_LINK - org.keycloak.events.EventType
 
SEND_IDENTITY_PROVIDER_LINK_ERROR - org.keycloak.events.EventType
 
SEND_RESET_PASSWORD - org.keycloak.events.EventType
 
SEND_RESET_PASSWORD_ERROR - org.keycloak.events.EventType
 
SEND_VERIFY_EMAIL - org.keycloak.events.EventType
 
SEND_VERIFY_EMAIL_ERROR - org.keycloak.events.EventType
 
sendConfirmIdentityBrokerLink(String, long) - Method in interface org.keycloak.email.EmailTemplateProvider
Send to confirm that user wants to link his account with identity broker link
sendEmailUpdateConfirmation(String, long, String) - Method in interface org.keycloak.email.EmailTemplateProvider
 
sendError(AuthenticationSessionModel, 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
sendPushRevocationPolicyRequest(RealmModel, ClientModel, int, String) - Method in interface org.keycloak.protocol.LoginProtocol
Send not-before revocation policy to the given client.
sendSmtpTestEmail(Map<String, String>, UserModel) - Method in interface org.keycloak.email.EmailTemplateProvider
Test SMTP connection with current logged in user
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
 
serializeKey() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
serializeKey() - Method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
serializePollingKey() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
serializeValue() - Method in class org.keycloak.models.OAuth2DeviceUserCodeModel
 
ServerInfoAwareProviderFactory - Interface in org.keycloak.provider
Marker interface for ProviderFactory of Provider which wants to show some info on "Server Info" page in Admin console.
ServerStartupError - Error in org.keycloak
Non-recoverable error thrown during server startup
ServerStartupError(String) - Constructor for error org.keycloak.ServerStartupError
 
ServerStartupError(String, boolean) - Constructor for error org.keycloak.ServerStartupError
 
services() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
Enables discovery of services via ServiceLoader.
session - Variable in class org.keycloak.broker.provider.AbstractIdentityProvider
 
session - Variable in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider
 
session(String) - Method in class org.keycloak.events.EventBuilder
 
session(UserSessionModel) - Method in class org.keycloak.events.EventBuilder
 
SESSION_EXPIRED - Static variable in interface org.keycloak.events.Errors
 
SessionExpiration - Class in org.keycloak.models.utils
 
SessionExpiration() - Constructor for class org.keycloak.models.utils.SessionExpiration
 
sessionFactory - Variable in class org.keycloak.services.scheduled.ScheduledTaskRunner
 
SESSIONS - org.keycloak.forms.account.AccountPages
 
SessionTimeoutHelper - Class in org.keycloak.models.utils
 
SessionTimeoutHelper() - Constructor for class org.keycloak.models.utils.SessionTimeoutHelper
 
setAccessible() - Method in interface org.keycloak.models.utils.reflection.Property
Calls the setAccessible method on the underlying member(s).
setAccessRequest(List<AuthorizationDetails>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setActionUri(URI) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAllowRemoteResourceManagement(boolean) - Method in interface org.keycloak.authorization.model.ResourceServer
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.
setAlternativeCredential(KeycloakSession, String, RealmModel) - Static method in class org.keycloak.utils.CredentialHelper
 
setAlwaysDisplayInConsole(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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.forms.account.AccountProvider
 
setAttribute(String, String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setAttribute(String, List<String>) - Method in interface org.keycloak.authorization.model.Resource
Sets an attribute with the given name and values.
setAttribute(String, List<String>) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setAttributeDisplayName(String) - Method in class org.keycloak.userprofile.AttributeMetadata
 
setAttributeGroupMetadata(AttributeGroupMetadata) - Method in class org.keycloak.userprofile.AttributeMetadata
 
setAuthContext(AuthenticationFlowContext) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setAuthDetails(AuthDetails) - Method in class org.keycloak.events.admin.AdminEvent
 
setAuthenticationFlowBindingOverride(String, String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setAuthenticationSelections(List<AuthenticationSelectionOption>) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
 
setAuthenticationSession(AuthenticationSessionModel) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setAuthenticationSession(AuthenticationSessionModel) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setAuthenticationSession(AuthenticationSessionModel) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setBaseUrl(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setBearerOnly(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setBrokerSessionId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setBrokerUserId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCalendar(Calendar) - Method in class org.keycloak.models.utils.TimeBasedOTP
 
setClient(ClientModel) - Method in interface org.keycloak.authentication.ClientAuthenticationFlowContext
Attach a specific client to this flow.
setClientAuthenticatorType(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setClientId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setClientId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setClientId(String) - Method in class org.keycloak.events.Event
 
setClientId(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setClientSessionCode(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setClientsIncluded(boolean) - Method in class org.keycloak.exportimport.ExportOptions
 
setCode(String) - Method in class org.keycloak.scripting.Script
 
setConfig(Map<String, String>) - Method in interface org.keycloak.authorization.model.Policy
Sets a Map with string-based key/value pairs representing any additional configuration for this policy.
setConfiguration(String) - Method in interface org.keycloak.userprofile.UserProfileProvider
Set new UserProfile configuration.
setConsentRequired(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setConsentScreenText(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setContextData(Map<String, Object>) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setCreatedTimestamp(Long) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setDecisionStrategy(DecisionStrategy) - Method in interface org.keycloak.authorization.model.Policy
Sets the {DecisionStrategy} for this policy.
setDecisionStrategy(DecisionStrategy) - Method in interface org.keycloak.authorization.model.ResourceServer
Defines a DecisionStrategy for this instance, indicating how permissions should be granted depending on the given decisionStrategy.
setDefaultClientAuthenticatorType(ClientModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
setDescription(String) - Method in interface org.keycloak.authorization.model.Policy
Sets the description for this policy.
setDescription(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setDescription(String) - Method in class org.keycloak.scripting.Script
 
setDetails(Map<String, String>) - Method in class org.keycloak.events.Event
 
setDirectAccessGrantsEnabled(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setDisplayDescription(String) - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
setDisplayHeader(String) - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
setDisplayName(String) - Method in interface org.keycloak.authorization.model.Resource
Sets an end user friendly name for this resource.
setDisplayName(String) - Method in interface org.keycloak.authorization.model.Scope
Sets an end user friendly name for this scope.
setDisplayOnConsentScreen(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setEffect(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
setEffect(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result.PolicyResult
 
setEmail(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setEmail(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setEmail(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setEmailVerified(boolean) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setEnabled(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setEnabled(boolean) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setEnabled(boolean) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
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.login.LoginFormsProvider
Set one global error message.
setError(Response.Status, String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setErrors(List<FormMessage>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
Set multiple error messages.
setErrors(Response.Status, List<FormMessage>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setEventBuilder(EventBuilder) - Method in interface org.keycloak.protocol.LoginProtocol
 
setEvents(List<Event>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setExecution(String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setFeatures(boolean, boolean, boolean, boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setFederationLink(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setFederationLink(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setFirstName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setFirstName(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setFirstName(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setForwardedInfoMessage(String, Object...) - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
 
setFrontchannelLogout(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setFullScopeAllowed(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setGranted(boolean) - Method in class org.keycloak.authorization.permission.ResourcePermission
 
setGrantedTimestamp(Long) - Method in interface org.keycloak.authorization.model.PermissionTicket
 
setGroupsAndRolesIncluded(boolean) - Method in class org.keycloak.exportimport.ExportOptions
 
setGuiOrder(int) - Method in class org.keycloak.userprofile.AttributeMetadata
 
setGuiOrder(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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.events.admin.AdminEvent
 
setId(String) - Method in class org.keycloak.events.Event
 
setId(String) - Method in class org.keycloak.scripting.Script
 
setIdp(IdentityProvider) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setIdpConfig(IdentityProviderModel) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setIdTokenHint(String) - Method in interface org.keycloak.forms.account.AccountProvider
 
setImplicitFlowEnabled(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setIncludeInTokenScope(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setInfo(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setIpAddress(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setIpAddress(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setIpAddress(String) - Method in class org.keycloak.events.Event
 
setIsDynamicScope(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setLastName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setLastName(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setLastName(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setLegacyId(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setLogic(Logic) - Method in interface org.keycloak.authorization.model.Policy
Sets the {Logic} for this policy.
setManagementUrl(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setMimeType(String) - Method in class org.keycloak.scripting.Script
 
setModelUsername(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setName(String) - Method in interface org.keycloak.authorization.model.Policy
Sets an unique name to this policy.
setName(String) - Method in interface org.keycloak.authorization.model.Resource
Sets a name for this resource.
setName(String) - Method in interface org.keycloak.authorization.model.Scope
Sets a name for this scope.
setName(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
setName(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setName(String) - Method in class org.keycloak.scripting.Script
 
setName(String) - Method in class org.keycloak.userprofile.AttributeGroupMetadata
 
setNodeReRegistrationTimeout(int) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setNotBefore(int) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setOnlyServiceAccountsIncluded(boolean) - Method in class org.keycloak.exportimport.ExportOptions
 
setOperationType(OperationType) - Method in class org.keycloak.events.admin.AdminEvent
 
setOrReplaceAuthenticationRequirement(KeycloakSession, RealmModel, String, AuthenticationExecutionModel.Requirement, AuthenticationExecutionModel.Requirement) - Static method in class org.keycloak.utils.CredentialHelper
 
setOwner(String) - Method in interface org.keycloak.authorization.model.Policy
 
setOwnerManagedAccess(boolean) - Method in interface org.keycloak.authorization.model.Resource
Sets if this resource can be managed by the resource owner.
setParameters(Object[]) - Method in exception org.keycloak.protocol.ProtocolMapperConfigException
 
setPasswordSet(boolean) - Method in interface org.keycloak.forms.account.AccountProvider
 
setPolicy(Policy) - Method in interface org.keycloak.authorization.model.PermissionTicket
 
setPolicy(Policy) - Method in class org.keycloak.authorization.policy.evaluation.DefaultEvaluation
 
setPolicyEnforcementMode(PolicyEnforcementMode) - Method in interface org.keycloak.authorization.model.ResourceServer
Defines a PolicyEnforcementMode for this instance.
setProfileFormData(MultivaluedMap<String, String>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setProtocol(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setPublicClient(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setReadOnly(boolean) - Method in interface org.keycloak.authorization.store.StoreFactory
Sets whether or not changes to instances returned from this factory are supported.
setRealm(RealmModel) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setRealm(RealmModel) - Method in interface org.keycloak.forms.account.AccountProvider
 
setRealm(RealmModel) - Method in interface org.keycloak.protocol.LoginProtocol
 
setRealmId(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setRealmId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setRealmId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setRealmId(String) - Method in class org.keycloak.events.Event
 
setRealmId(String) - Method in class org.keycloak.scripting.Script
 
setRealmModel(RealmModel) - Method in class org.keycloak.storage.ImportRealmFromRepresentation
Deprecated.
 
setRedirectUris(Set<String>) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setReferrer(String[]) - Method in interface org.keycloak.forms.account.AccountProvider
 
setRegistrationToken(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setRepresentation(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setRequiredActions(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.Authenticator
Set actions to configure authenticator
setRequiredActions(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.authentication.FormAction
Set actions to configure authenticator
setRequiredCredential(KeycloakSession, String, RealmModel) - Static method in class org.keycloak.utils.CredentialHelper
 
setResourcePath(String) - Method in class org.keycloak.events.admin.AdminEvent
 
setResourceType(ResourceType) - Method in class org.keycloak.events.admin.AdminEvent
 
setResourceTypeAsString(String) - Method in class org.keycloak.events.admin.AdminEvent
Setter for custom resource types with values different from ResourceType.
setResponseHeader(String, String) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setRootUrl(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setSecret(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setServiceAccountClientLink(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setServiceAccountsEnabled(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setSession(KeycloakSession) - Method in interface org.keycloak.protocol.LoginProtocol
 
setSessionId(String) - Method in class org.keycloak.events.Event
 
setSessions(List<UserSessionModel>) - Method in interface org.keycloak.forms.account.AccountProvider
 
setSingleAttribute(String, String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setStandardFlowEnabled(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
setStateChecker(String) - Method in interface org.keycloak.forms.account.AccountProvider
 
setStatus(Response.Status) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setStatus(Decision.Effect) - Method in class org.keycloak.authorization.policy.evaluation.Result
 
setStatusCode(Response.Status) - Method in class org.keycloak.validate.ValidationError
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setSuccess(String, Object...) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setSurrogateAuthRequired(boolean) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
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
setTimeouts(long, long) - Method in class org.keycloak.models.dblock.NoLockingDBLockProviderFactory
 
setToken(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setTransactionLimit(KeycloakSessionFactory, int) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
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(String) - Method in interface org.keycloak.exportimport.ExportAdapter
Set the mime type of the output.
setType(EventType) - Method in class org.keycloak.events.Event
 
setupAdminCli(RealmModel) - Method in interface org.keycloak.migration.MigrationProvider
 
setupAuthorizationServices(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
setupClientDefaults(ClientRepresentation, ClientModel) - Method in interface org.keycloak.protocol.LoginProtocolFactory
Setup default values for new clients.
setupConfiguration(CONFIG) - Method in class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider
 
setupConfiguration(CONFIG) - Method in interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider
setup this condition's configuration.
setupConfiguration(CONFIG) - Method in interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider
setup this executor's configuration.
setupDefaultRole(RealmModel, String) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
Creates default role for particular realm with the given name.
setupDeleteAccount(ClientModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
setupImpersonationService(KeycloakSession, RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setupMasterRealmRole(RealmProvider, RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setupOfflineRole(RealmModel) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
setupRealmRole(RealmModel) - Static method in class org.keycloak.models.ImpersonationConstants
 
setUriInfo(UriInfo) - Method in interface org.keycloak.forms.account.AccountProvider
 
setUriInfo(UriInfo) - Method in interface org.keycloak.protocol.LoginProtocol
 
setUser(UserModel) - Method in interface org.keycloak.authentication.AuthenticationFlowContext
Attach a specific user to this flow.
setUser(UserModel) - Method in interface org.keycloak.authentication.FormContext
Attach a specific user to this flow.
setUser(UserModel) - Method in interface org.keycloak.email.EmailTemplateProvider
 
setUser(UserModel) - Method in interface org.keycloak.forms.account.AccountProvider
 
setUser(UserModel) - Method in interface org.keycloak.forms.login.LoginFormsProvider
 
setUserAttribute(String, String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUserAttribute(String, List<String>) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUserId(String) - Method in class org.keycloak.events.admin.AuthDetails
 
setUserId(String) - Method in class org.keycloak.events.admin.AuthQuery
 
setUserId(String) - Method in class org.keycloak.events.Event
 
setUsername(String) - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
setUsername(String) - Method in class org.keycloak.models.utils.ReadOnlyUserModelDelegate
 
setUsername(String) - Method in class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
setUsersIncluded(boolean) - Method in class org.keycloak.exportimport.ExportOptions
 
setValue(Object, V) - Method in interface org.keycloak.models.utils.reflection.Property
This method sets the property value for a specified bean to the specified value.
setWarning(String, Object...) - Method in interface org.keycloak.forms.account.AccountProvider
 
setWebOrigins(Set<String>) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
SHAPasswordEncoder - Class in org.keycloak.models.utils
Password that uses SHA to encode passwords.
SHAPasswordEncoder(int) - Constructor for class org.keycloak.models.utils.SHAPasswordEncoder
 
shouldAttachRoute() - Method in class org.keycloak.sessions.DisabledStickySessionEncoderProvider
 
shouldAttachRoute() - Method in interface org.keycloak.sessions.StickySessionEncoderProvider
 
SIGNATURE_ALGORITHM - Static variable in interface org.keycloak.events.Details
 
SIGNATURE_REQUIRED - Static variable in interface org.keycloak.events.Details
 
SignatureProvider - Interface in org.keycloak.crypto
 
SignatureProviderFactory - Interface in org.keycloak.crypto
 
SignatureSpi - Class in org.keycloak.crypto
 
SignatureSpi() - Constructor for class org.keycloak.crypto.SignatureSpi
 
signer() - Method in interface org.keycloak.crypto.SignatureProvider
 
signer(KeyWrapper) - Method in interface org.keycloak.crypto.SignatureProvider
 
SimpleHttp - Class in org.keycloak.broker.provider.util
 
SimpleHttp(String, String, HttpClient) - Constructor for class org.keycloak.broker.provider.util.SimpleHttp
 
SimpleHttp.Response - Class in org.keycloak.broker.provider.util
 
SimpleValidator - Interface in org.keycloak.validate
Convenience interface to ease implementation of small Validator implementations.
SingleUseObjectProvider - Interface in org.keycloak.models
Provides a cache to store data for single-use use case or the details about used action tokens.
SingleUseObjectProviderFactory<T extends SingleUseObjectProvider> - Interface in org.keycloak.models
 
SingleUseObjectSpi - Class in org.keycloak.models
 
SingleUseObjectSpi() - Constructor for class org.keycloak.models.SingleUseObjectSpi
 
size() - Method in class org.keycloak.authorization.attribute.Attributes.Entry
 
size() - Method in class org.keycloak.validate.ValidatorConfig
 
SKIP - org.keycloak.exportimport.UsersExportStrategy
 
SKIP_LINK - Static variable in class org.keycloak.models.Constants
 
skipHeaders() - Method in interface org.keycloak.headers.SecurityHeadersOptions
 
skipValidation(Object, ValidatorConfig) - Method in class org.keycloak.validate.AbstractSimpleValidator
Decide if validation of individual value should be skipped or not.
skipValidation(Object, ValidatorConfig) - Method in class org.keycloak.validate.AbstractStringValidator
 
skipValidation(Object, ValidatorConfig) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
 
SLOW_DOWN - Static variable in interface org.keycloak.events.Errors
 
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
 
socketTimeOutMillis(int) - Method in class org.keycloak.broker.provider.util.SimpleHttp
 
SpecialCharsPasswordPolicyProvider - Class in org.keycloak.policy
 
SpecialCharsPasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
SpecialCharsPasswordPolicyProviderFactory - Class in org.keycloak.policy
 
SpecialCharsPasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory
 
SPI_NAME - Static variable in class org.keycloak.authentication.AuthenticatorSpi
 
SPI_NAME - Static variable in class org.keycloak.protocol.oidc.TokenExchangeSpi
 
SPI_NAME - Static variable in class org.keycloak.services.clientpolicy.condition.ClientPolicyConditionSpi
 
SPI_NAME - Static variable in class org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorSpi
 
splitClaimPath(String) - Static method in class org.keycloak.utils.JsonUtils
Splits the given claim into separate paths if the value contains separators as per JsonUtils.CLAIM_COMPONENT.
SSL_REQUIRED - Static variable in interface org.keycloak.events.Errors
 
START_TLS - Static variable in class org.keycloak.models.LDAPConstants
 
StickySessionEncoderProvider - Interface in org.keycloak.sessions
 
StickySessionEncoderProviderFactory - Interface in org.keycloak.sessions
 
StickySessionEncoderSpi - Class in org.keycloak.sessions
 
StickySessionEncoderSpi() - Constructor for class org.keycloak.sessions.StickySessionEncoderSpi
 
STORAGE_BATCH_ENABLED - Static variable in class org.keycloak.models.Constants
If set as an attribute in the KeycloakSession, indicates that the storage should batch write operations.
STORAGE_BATCH_SIZE - Static variable in class org.keycloak.models.Constants
If #STORAGE_BATCH_ENABLED is set, indicates the batch size.
storeFactory - Variable in class org.keycloak.authorization.model.AbstractAuthorizationModel
 
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
 
StreamsUtil - Class in org.keycloak.utils
 
StreamsUtil() - Constructor for class org.keycloak.utils.StreamsUtil
 
STREET - Static variable in class org.keycloak.models.LDAPConstants
 
STRICT - org.keycloak.truststore.HostnameVerificationPolicy
CN must match hostname connecting to
STRICT_TRANSPORT_SECURITY - org.keycloak.models.BrowserSecurityHeaders
 
strip(KeycloakSession, String, ComponentExportRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(ClientRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(IdentityProviderRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(RealmRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
strip(UserRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
stripForExport(KeycloakSession, RealmRepresentation) - Static method in class org.keycloak.models.utils.StripSecretsUtils
 
stripRealmAttributesIncludedAsFields(Map<String, String>) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
StripSecretsUtils - Class in org.keycloak.models.utils
 
StripSecretsUtils() - Constructor for class org.keycloak.models.utils.StripSecretsUtils
 
SUB_TYPE - org.keycloak.models.utils.reflection.TypedPropertyCriteria.MatchOption
 
success() - Method in interface org.keycloak.authentication.AbstractAuthenticationFlowContext
Mark the current execution as 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
 
success(FormContext) - Method in interface org.keycloak.authentication.FormAction
Called after all validate() calls of all FormAction providers are successful.
SUCCESS - org.keycloak.authentication.FlowStatus
Successful execution
SUCCESS - org.keycloak.authentication.RequiredActionContext.KcActionStatus
 
SUCCESS - org.keycloak.authentication.RequiredActionContext.Status
 
successfulLogin(RealmModel, UserModel, ClientConnection) - Method in interface org.keycloak.services.managers.BruteForceProtector
 
successMessage - Variable in exception org.keycloak.authentication.ForkFlowException
 
SUPER_TYPE - org.keycloak.models.utils.reflection.TypedPropertyCriteria.MatchOption
 
SUPPORTED - org.keycloak.authentication.InitiatedActionSupport
 
supports(String) - Method in interface org.keycloak.provider.ProviderLoaderFactory
 
supports(OTPPolicy) - Method in interface org.keycloak.authentication.otp.OTPApplicationProvider
 
supports(TokenExchangeContext) - Method in interface org.keycloak.protocol.oidc.TokenExchangeProvider
Check if exchange request is supported by this provider
supportsForcedUnlock() - Method in interface org.keycloak.models.dblock.DBLockProvider
 
supportsSecret() - Method in interface org.keycloak.authentication.ClientAuthenticatorFactory
Is this authenticator supports client secret?
supportsSyncMode(IdentityProviderSyncMode) - Method in interface org.keycloak.broker.provider.IdentityProviderMapper
 
suspendJtaTransaction(KeycloakSessionFactory, Runnable) - Static method in class org.keycloak.models.utils.KeycloakModelUtils
 
SYNC_REGISTRATIONS - Static variable in class org.keycloak.models.LDAPConstants
 
synchronize(E, KeycloakSessionFactory) - Method in interface org.keycloak.authorization.store.syncronization.Synchronizer
 
synchronize(ClientModel.ClientRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.ClientApplicationSynchronizer
 
synchronize(GroupModel.GroupRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.GroupSynchronizer
 
synchronize(RealmModel.RealmRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.RealmSynchronizer
 
synchronize(UserModel.UserRemovedEvent, KeycloakSessionFactory) - Method in class org.keycloak.authorization.store.syncronization.UserSynchronizer
 
Synchronizer<E extends ProviderEvent> - Interface in org.keycloak.authorization.store.syncronization
 
SYSTEM_CLIENT_ID - Static variable in class org.keycloak.models.utils.SystemClientUtil
 
SYSTEM_PROPERTY - Static variable in class org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 
SystemClientUtil - Class in org.keycloak.models.utils
 
SystemClientUtil() - Constructor for class org.keycloak.models.utils.SystemClientUtil
 

T

TAB_ID - Static variable in class org.keycloak.models.Constants
 
task - Variable in class org.keycloak.services.scheduled.ScheduledTaskRunner
 
TEMPLATE_ATTR_ACTION_URI - Static variable in class org.keycloak.models.Constants
 
TEMPLATE_ATTR_REQUIRED_ACTIONS - Static variable in class org.keycloak.models.Constants
 
TERMS_AND_CONDITIONS - org.keycloak.models.utils.DefaultRequiredActions.Action
 
ThemeProvider - Interface in org.keycloak.theme
 
ThemeProviderFactory - Interface in org.keycloak.theme
 
themeResources() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
Enables discovery of embedded theme-resources.
themes() - Method in class org.keycloak.provider.KeycloakDeploymentInfo
Enables discovery embedded themes.
ThemeSpi - Class in org.keycloak.theme
 
ThemeSpi() - Constructor for class org.keycloak.theme.ThemeSpi
 
throwExceptionIfReadonly() - Method in class org.keycloak.authorization.model.AbstractAuthorizationModel
 
throwIfEmpty(Stream<T>, RuntimeException) - Static method in class org.keycloak.utils.StreamsUtil
Returns the original stream if the stream is not empty.
TIME_SKEW - Static variable in class org.keycloak.utils.OCSPProvider
 
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
 
TimerProvider.TimerTaskContext - 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
 
TIMESTAMP - Static variable in class org.keycloak.events.admin.AdminEvent.SearchableFields
 
TIMESTAMP - Static variable in class org.keycloak.events.Event.SearchableFields
 
toBriefRepresentation(RealmModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toBriefRepresentation(RoleModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toBriefRepresentation(UserModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toDate(Date) - Method in interface org.keycloak.events.EventQuery
Search events that are older than toDate
toEventsConfigReprensetation(RealmModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(GroupModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(GroupModel, boolean, String) - Static method in class org.keycloak.models.utils.ModelToRepresentation
Deprecated.
toGroupHierarchy(GroupModel, boolean, String, Boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(GroupModel, boolean, Map<String, String>) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(RealmModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(RealmModel, boolean, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(UserModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toGroupHierarchy(UserModel, boolean, Integer, Integer) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
TOKEN_ENDPOINT_AUTH_SIGNING_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
TOKEN_EXCHANGE - org.keycloak.events.EventType
 
TOKEN_EXCHANGE_ERROR - org.keycloak.events.EventType
 
TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
TokenExchangeContext - Class in org.keycloak.protocol.oidc
Token exchange context
TokenExchangeContext(KeycloakSession, MultivaluedMap<String, String>, Object, RealmModel, EventBuilder, ClientModel, ClientConnection, HttpHeaders, Object, Map<String, String>) - Constructor for class org.keycloak.protocol.oidc.TokenExchangeContext
 
TokenExchangeContext.Params - Class in org.keycloak.protocol.oidc
 
TokenExchangeProvider - Interface in org.keycloak.protocol.oidc
Provides token exchange mechanism for supported tokens
TokenExchangeProviderFactory - Interface in org.keycloak.protocol.oidc
A factory that creates TokenExchangeProvider instances.
TokenExchangeSpi - Class in org.keycloak.protocol.oidc
A Spi to support pluggable token exchange handlers in the OAuth2 Token Endpoint.
TokenExchangeSpi() - Constructor for class org.keycloak.protocol.oidc.TokenExchangeSpi
 
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.
toMap() - Method in class org.keycloak.models.OAuth2DeviceCodeModel
 
toMap() - Method in interface org.keycloak.userprofile.Attributes
 
toMap() - Method in class org.keycloak.userprofile.DefaultAttributes
 
toModel(KeycloakSession, ComponentRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, AuthenticationExecutionRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(RealmModel, IdentityProviderRepresentation, KeycloakSession) - 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(AuthenticatorConfigRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(AbstractPolicyRepresentation, AuthorizationProvider, Policy) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(PermissionTicketRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ResourceRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ResourceServerRepresentation, AuthorizationProvider, ClientModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ScopeRepresentation, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ScopeRepresentation, ResourceServer, AuthorizationProvider, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(CredentialRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(IdentityProviderMapperRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toModel(ProtocolMapperRepresentation) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
toRepresentation(List<ProviderConfigProperty>) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(PermissionTicket, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(PermissionTicket, AuthorizationProvider, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Policy, AuthorizationProvider) - Method in interface org.keycloak.authorization.policy.provider.PolicyProviderFactory
 
toRepresentation(Policy, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Policy, AuthorizationProvider, boolean, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Policy, AuthorizationProvider, boolean, boolean, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Resource, ResourceServer, AuthorizationProvider) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Resource, ResourceServer, AuthorizationProvider, Boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ResourceServer, ClientModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(Scope) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(CredentialMetadata) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(CredentialModel) - 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(Event) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(AuthenticatorConfigModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ClientModel, KeycloakSession) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ClientScopeModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(FederatedIdentityModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(GroupModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(IdentityProviderMapperModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(KeycloakSession, ComponentModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(KeycloakSession, RealmModel, boolean) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(KeycloakSession, RealmModel, UserModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ProtocolMapperModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, AuthenticationExecutionModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, AuthenticationFlowModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RealmModel, IdentityProviderModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RequiredActionProviderModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(RoleModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserConsentModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserCredentialModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(UserSessionModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentation(ProviderConfigProperty) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toRepresentationWithoutConfig(ComponentModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toResourceServerRepresentation(KeycloakSession, ClientModel) - Static method in class org.keycloak.models.utils.ModelToRepresentation
 
toResult() - Method in class org.keycloak.validate.ValidationContext
Creates a ValidationResult based on the current errors;
toResult() - Method in class org.keycloak.validation.DefaultValidationContext
 
toResult() - Method in interface org.keycloak.validation.ValidationContext
 
toString() - Method in class org.keycloak.authentication.AuthenticationSelectionOption
 
toString() - Method in class org.keycloak.broker.provider.BrokeredIdentityContext
 
toString() - Method in class org.keycloak.migration.ModelVersion
 
toString() - Method in class org.keycloak.models.utils.FormMessage
 
toString() - Method in class org.keycloak.scripting.Script
 
toString() - Method in class org.keycloak.userprofile.ValidationException.Error
 
toString() - Method in exception org.keycloak.userprofile.ValidationException
 
toString() - Method in class org.keycloak.utils.ProxyClassLoader
 
toString() - Method in class org.keycloak.validate.ValidationContext
 
toString() - Method in class org.keycloak.validate.ValidationError
 
toString() - Method in class org.keycloak.validate.ValidatorConfig
 
toTime(Date) - Method in interface org.keycloak.events.admin.AdminEventQuery
Search by events before the specified time
TOTP - org.keycloak.forms.account.AccountPages
 
TransactionManagerLookupSpi - Class in org.keycloak.transaction
 
TransactionManagerLookupSpi() - Constructor for class org.keycloak.transaction.TransactionManagerLookupSpi
 
TRUST_EMAIL - Static variable in class org.keycloak.models.LDAPConstants
 
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
Search events with given types
TYPE - org.keycloak.authorization.model.Policy.FilterOption
 
TYPE - org.keycloak.authorization.model.Resource.FilterOption
 
TYPE - Static variable in class org.keycloak.authorization.model.Policy.SearchableFields
 
TYPE - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
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
 
UNAUTHORIZED_CLIENT - Static variable in interface org.keycloak.events.Errors
 
UnboundedPermissionEvaluator - Class in org.keycloak.authorization.permission.evaluator
 
UNKNOWN - org.keycloak.utils.OCSPProvider.RevocationStatus
 
UNKNOWN_CLIENT - org.keycloak.authentication.AuthenticationFlowError
 
UNKNOWN_IDENTITY_PROVIDER - Static variable in interface org.keycloak.events.Errors
 
UNKNOWN_USER - org.keycloak.authentication.AuthenticationFlowError
 
unknownStatus() - Static method in class org.keycloak.utils.OCSPProvider
 
UNREGISTER_NODE - org.keycloak.events.EventType
 
UNREGISTER_NODE_ERROR - org.keycloak.events.EventType
 
unregisterNode(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
UNSUPPORTED_NAMEID_FORMAT - Static variable in interface org.keycloak.events.Errors
 
update(boolean, AttributeChangeListener...) - Method in class org.keycloak.userprofile.DefaultUserProfile
 
update(boolean, AttributeChangeListener...) - Method in interface org.keycloak.userprofile.UserProfile
Updates the UserModel associated with this instance.
update(AttributeChangeListener...) - Method in interface org.keycloak.userprofile.UserProfile
The same as #update(boolean, BiConsumer[]) but forcing the removal of attributes.
UPDATE - org.keycloak.events.admin.OperationType
 
UPDATE - org.keycloak.validation.ValidationContext.Event
 
UPDATE_CONSENT - org.keycloak.events.EventType
 
UPDATE_CONSENT_ERROR - org.keycloak.events.EventType
 
UPDATE_EMAIL - org.keycloak.events.EventType
 
UPDATE_EMAIL - org.keycloak.forms.login.LoginFormsPages
 
UPDATE_EMAIL - org.keycloak.models.utils.DefaultRequiredActions.Action
 
UPDATE_EMAIL - org.keycloak.userprofile.UserProfileContext
 
UPDATE_EMAIL_ERROR - org.keycloak.events.EventType
 
UPDATE_PASSWORD - org.keycloak.events.EventType
 
UPDATE_PASSWORD - org.keycloak.models.utils.DefaultRequiredActions.Action
 
UPDATE_PASSWORD_ERROR - org.keycloak.events.EventType
 
UPDATE_PROFILE - org.keycloak.events.EventType
 
UPDATE_PROFILE - org.keycloak.models.utils.DefaultRequiredActions.Action
 
UPDATE_PROFILE - org.keycloak.userprofile.UserProfileContext
 
UPDATE_PROFILE_CONTEXT_ATTR - Static variable in interface org.keycloak.forms.login.LoginFormsProvider
 
UPDATE_PROFILE_ERROR - org.keycloak.events.EventType
 
UPDATE_TOTP - org.keycloak.events.EventType
 
UPDATE_TOTP_ERROR - org.keycloak.events.EventType
 
UPDATE_USER_LOCALE - org.keycloak.models.utils.DefaultRequiredActions.Action
 
UPDATE_USER_PROFILE - org.keycloak.forms.login.LoginFormsPages
 
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 class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
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.
updateBrokeredUserLegacy(KeycloakSession, RealmModel, UserModel, IdentityProviderMapperModel, BrokeredIdentityContext) - Method in class org.keycloak.broker.provider.AbstractIdentityProviderMapper
 
updateBrokeredUserLegacy(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 class org.keycloak.models.delegate.ClientModelLazyDelegate
 
updateClient(ClientRepresentation, ClientModel, KeycloakSession) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateClientProtocolMappers(ClientRepresentation, ClientModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateClientScope(ClientScopeRepresentation, ClientScopeModel) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateComponent(KeycloakSession, ComponentRepresentation, ComponentModel, boolean) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateConfigPropertyIfNecessary(ClientModel.ClientIdChangeEvent, String, Consumer<String>) - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByClientIdSynchronizer
 
updateConfigPropertyIfNecessary(GroupModel.GroupPathChangeEvent, String, Consumer<String>) - Method in class org.keycloak.broker.provider.mappersync.GroupConfigPropertyByPathSynchronizer
 
updateConfigPropertyIfNecessary(RoleModel.RoleNameChangeEvent, String, Consumer<String>) - Method in class org.keycloak.broker.provider.mappersync.RoleConfigPropertyByRoleNameSynchronizer
 
updateConfigPropertyIfNecessary(T, String, Consumer<String>) - Method in class org.keycloak.broker.provider.mappersync.AbstractConfigPropertySynchronizer
 
UPDATED_EMAIL - Static variable in interface org.keycloak.events.Details
 
UPDATED_FIRST_NAME - Static variable in interface org.keycloak.events.Details
 
UPDATED_LAST_NAME - Static variable in interface org.keycloak.events.Details
 
UPDATED_REFRESH_TOKEN_ID - Static variable in interface org.keycloak.events.Details
 
updateDefaultRoles(String...) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
UpdateOnlyChangeUserModelDelegate - Class in org.keycloak.storage.adapter
This will perform update operation for particular attribute/property just if the existing value is not already same.
UpdateOnlyChangeUserModelDelegate(UserModel) - Constructor for class org.keycloak.storage.adapter.UpdateOnlyChangeUserModelDelegate
 
updateOTPRequiredAction(RequiredActionProviderModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
updatePolicy(PermissionTicket, StoreFactory) - Static method in class org.keycloak.authorization.UserManagedPermissionUtil
 
updateProtocolMapper(ProtocolMapperModel) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
updateProtocolMappers(ProtocolMapperContainerModel) - Static method in class org.keycloak.migration.migrators.MigrationUtils
 
updateRealm(RealmRepresentation, RealmModel) - Method in interface org.keycloak.storage.ExportImportManager
 
updateRealm(RealmRepresentation, RealmModel, KeycloakSession) - Static method in class org.keycloak.models.utils.RepresentationToModel
 
updateScopes(Set<Scope>) - Method in interface org.keycloak.authorization.model.Resource
Update the set of scopes associated with this resource.
updateUris(Set<String>) - Method in interface org.keycloak.authorization.model.Resource
Sets a list of URI that uniquely identify this resource.
UpperCasePasswordPolicyProvider - Class in org.keycloak.policy
 
UpperCasePasswordPolicyProvider(KeycloakContext) - Constructor for class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
UpperCasePasswordPolicyProviderFactory - Class in org.keycloak.policy
 
UpperCasePasswordPolicyProviderFactory() - Constructor for class org.keycloak.policy.UpperCasePasswordPolicyProviderFactory
 
URI - org.keycloak.authorization.model.Resource.FilterOption
 
URI - Static variable in class org.keycloak.authorization.model.Resource.SearchableFields
 
URI_NOT_NULL - org.keycloak.authorization.model.Resource.FilterOption
 
uriValidator() - Static method in class org.keycloak.validate.Validators
 
UriValidator - Class in org.keycloak.validate.validators
URI validation - accepts URI, URL and single String.
UriValidator() - Constructor for class org.keycloak.validate.validators.UriValidator
 
USE_JWKS_STRING - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USE_JWKS_URL - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USE_LOWER_CASE_IN_TOKEN_RESPONSE - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USE_MTLS_HOK_TOKEN - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USE_PASSWORD_MODIFY_EXTENDED_OP - Static variable in class org.keycloak.models.LDAPConstants
 
USE_REFRESH_TOKEN - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USE_REFRESH_TOKEN_FOR_CLIENT_CREDENTIALS_GRANT - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
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 - Variable in class org.keycloak.userprofile.DefaultAttributes
 
user(String) - Method in class org.keycloak.events.EventBuilder
 
user(String) - Method in interface org.keycloak.events.EventQuery
Search events for only one user
user(UserModel) - Method in class org.keycloak.events.EventBuilder
 
USER - org.keycloak.events.admin.ResourceType
 
USER_ACCOUNT_CONTROL - Static variable in class org.keycloak.models.LDAPConstants
 
USER_API - org.keycloak.userprofile.UserProfileContext
 
USER_ATTRIBUTES_PREFIX - Static variable in class org.keycloak.models.Constants
 
USER_CONFLICT - org.keycloak.authentication.AuthenticationFlowError
 
USER_DELETE_ERROR - Static variable in interface org.keycloak.events.Errors
 
USER_DISABLED - org.keycloak.authentication.AuthenticationFlowError
 
USER_DISABLED - Static variable in interface org.keycloak.events.Errors
 
USER_FEDERATION_MAPPER - org.keycloak.events.admin.ResourceType
 
USER_FEDERATION_PROVIDER - org.keycloak.events.admin.ResourceType
 
USER_ID - Static variable in class org.keycloak.events.Event.SearchableFields
 
USER_INFO_ENCRYPTED_RESPONSE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USER_INFO_ENCRYPTED_RESPONSE_ENC - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USER_INFO_REQUEST - org.keycloak.events.EventType
 
USER_INFO_REQUEST_ERROR - org.keycloak.events.EventType
 
USER_INFO_RESPONSE_SIGNATURE_ALG - Static variable in class org.keycloak.protocol.oidc.OIDCConfigAttributes
 
USER_LOGIN_FAILURE - org.keycloak.events.admin.ResourceType
 
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 - org.keycloak.events.admin.ResourceType
 
USER_SESSION_NOT_FOUND - Static variable in interface org.keycloak.events.Errors
 
USER_TEMPORARILY_DISABLED - org.keycloak.authentication.AuthenticationFlowError
 
USER_TEMPORARILY_DISABLED - Static variable in interface org.keycloak.events.Errors
 
userCache() - Method in interface org.keycloak.models.LegacySessionSupportProvider
Deprecated.
userCredentialManager() - Method in interface org.keycloak.models.LegacySessionSupportProvider
Deprecated.
UserLoginFailureProviderFactory<T extends UserLoginFailureProvider> - Interface in org.keycloak.models
 
UserLoginFailureSpi - Class in org.keycloak.models
 
UserLoginFailureSpi() - Constructor for class org.keycloak.models.UserLoginFailureSpi
 
UserManagedPermissionUtil - Class in org.keycloak.authorization
 
UserManagedPermissionUtil() - Constructor for class org.keycloak.authorization.UserManagedPermissionUtil
 
USERNAME - Static variable in interface org.keycloak.events.Details
 
USERNAME - Static variable in class org.keycloak.models.ClaimMask
 
USERNAME_HIDDEN - 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
 
UserProfile - Interface in org.keycloak.userprofile
An interface providing as an entry point for managing users.
UserProfileAttributeValidationContext - Class in org.keycloak.userprofile
Extension of the ValidationContext used when validators are called for UserProfile attribute validation.
UserProfileAttributeValidationContext(AttributeContext) - Constructor for class org.keycloak.userprofile.UserProfileAttributeValidationContext
 
UserProfileContext - Enum in org.keycloak.userprofile
This interface represents the different contexts from where user profiles are managed.
UserProfileMetadata - Class in org.keycloak.userprofile
 
UserProfileMetadata(UserProfileContext) - Constructor for class org.keycloak.userprofile.UserProfileMetadata
 
UserProfileProvider - Interface in org.keycloak.userprofile
The provider responsible for creating UserProfile instances.
UserProfileProviderFactory<U extends UserProfileProvider> - Interface in org.keycloak.userprofile
 
UserProfileSpi - Class in org.keycloak.userprofile
 
UserProfileSpi() - Constructor for class org.keycloak.userprofile.UserProfileSpi
 
UserProviderFactory<T extends UserProvider> - Interface in org.keycloak.models
 
users() - Method in interface org.keycloak.storage.DatastoreProvider
 
USERS_DN - Static variable in class org.keycloak.models.LDAPConstants
 
UserSessionNoteDescriptor - Interface in org.keycloak.models
Describes a user session note for simple and generic ProtocolMapperModel creation.
UserSessionProviderFactory<T extends UserSessionProvider> - Interface in org.keycloak.models
 
UserSessionSpi - Class in org.keycloak.models
 
UserSessionSpi() - Constructor for class org.keycloak.models.UserSessionSpi
 
UsersExportStrategy - Enum in org.keycloak.exportimport
 
UserSpi - Class in org.keycloak.models
 
UserSpi() - Constructor for class org.keycloak.models.UserSpi
 
UserSynchronizer - Class in org.keycloak.authorization.store.syncronization
 
UserSynchronizer() - Constructor for class org.keycloak.authorization.store.syncronization.UserSynchronizer
 
UUID_LDAP_ATTRIBUTE - Static variable in class org.keycloak.models.LDAPConstants
 

V

validate() - Method in class org.keycloak.userprofile.DefaultUserProfile
 
validate() - Method in interface org.keycloak.userprofile.UserProfile
Validates the attributes associated with this instance.
validate(Object) - Method in interface org.keycloak.validate.Validator
Validates the given input.
validate(Object, String) - Method in interface org.keycloak.validate.Validator
Validates the given input with an additional inputHint.
validate(Object, String, ValidationContext) - Method in interface org.keycloak.validate.Validator
Validates the given input with an additional inputHint.
validate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.AbstractSimpleValidator
 
validate(Object, String, ValidationContext, ValidatorConfig) - Method in interface org.keycloak.validate.Validator
Validates the given input with an additional inputHint and config.
validate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.NotBlankValidator
 
validate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.NotEmptyValidator
 
validate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.UriValidator
 
validate(Object, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.ValidatorConfigValidator
 
validate(Object, String, ValidatorConfig) - Method in interface org.keycloak.validate.Validator
Validates the given input with an additional inputHint.
validate(Object, ValidationContext) - Method in interface org.keycloak.validate.Validator
Validates the given input.
validate(Object, ValidatorConfig) - Method in interface org.keycloak.validate.Validator
Validates the given input with an additional config.
validate(String, String) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProvider
Checks whether the provided password is contained in the configured blacklist.
validate(String, String) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
validate(String, String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
validate(String, String) - Method in interface org.keycloak.policy.PasswordPolicyManagerProvider
 
validate(String, String) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
validate(String, String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
validate(String, String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
validate(String, Consumer<ValidationError>...) - Method in interface org.keycloak.userprofile.Attributes
Validates the attribute with the given name.
validate(String, Consumer<ValidationError>...) - Method in class org.keycloak.userprofile.DefaultAttributes
 
validate(ValidationContext) - Method in interface org.keycloak.authentication.FormAction
This is the first phase of form processing.
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.BlacklistPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.DefaultPasswordPolicyManagerProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.DigitsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.HistoryPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.LengthPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.LowerCasePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.MaximumLengthPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.NotEmailPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.NotUsernamePasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in interface org.keycloak.policy.PasswordPolicyManagerProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.RegexPatternsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.SpecialCharsPasswordPolicyProvider
 
validate(RealmModel, UserModel, String) - Method in class org.keycloak.policy.UpperCasePasswordPolicyProvider
 
validate(AttributeContext) - Method in class org.keycloak.userprofile.AttributeValidatorMetadata
Run validation for given AttributeContext.
validate(ClientValidationContext.OIDCContext) - Method in interface org.keycloak.validation.ClientValidationProvider
 
validate(ValidationContext<T>) - Method in interface org.keycloak.validation.Validator
 
VALIDATE_ACCESS_TOKEN - org.keycloak.events.EventType
Deprecated.
see KEYCLOAK-2266
VALIDATE_ACCESS_TOKEN - Static variable in interface org.keycloak.events.Details
 
VALIDATE_ACCESS_TOKEN_ERROR - org.keycloak.events.EventType
Deprecated.
VALIDATE_PASSWORD_POLICY - Static variable in class org.keycloak.models.LDAPConstants
 
validateClient(KeycloakSession, ClientModel, boolean, ValidationUtil.ErrorHandler) - Static method in class org.keycloak.validation.ValidationUtil
 
validateClient(KeycloakSession, ClientModel, OIDCClientRepresentation, boolean, ValidationUtil.ErrorHandler) - Static method in class org.keycloak.validation.ValidationUtil
 
validateConfig(String, ValidatorConfig) - Method in class org.keycloak.validate.Validators
Validates the ValidatorConfig of Validator referenced by the given provider id.
validateConfig(KeycloakSession, String, ValidatorConfig) - Static method in class org.keycloak.validate.Validators
Validates the ValidatorConfig of Validator referenced by the given provider id.
validateConfig(KeycloakSession, RealmModel, ProtocolMapperContainerModel, ProtocolMapperModel) - Method in interface org.keycloak.protocol.ProtocolMapper
Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint
validateConfig(KeycloakSession, ValidatorConfig) - Method in interface org.keycloak.validate.ValidatorFactory
Validates the given validation config.
validateConfig(KeycloakSession, ValidatorConfig) - Method in class org.keycloak.validate.validators.AbstractNumberValidator
 
validateConfig(KeycloakSession, ValidatorConfig) - Method in class org.keycloak.validate.validators.LengthValidator
 
validateConfig(KeycloakSession, ValidatorConfig) - Method in class org.keycloak.validate.validators.LocalDateValidator
 
validateConfig(KeycloakSession, ValidatorConfig) - Method in class org.keycloak.validate.validators.OptionsValidator
 
validateConfig(KeycloakSession, ValidatorConfig) - Method in class org.keycloak.validate.validators.PatternValidator
 
validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.role.RoleStorageProviderFactory
 
validateSecret(String) - Method in class org.keycloak.models.delegate.ClientModelLazyDelegate
 
validateStringValue(String, String, ValidationContext, ValidatorConfig) - Method in class org.keycloak.validate.validators.NotBlankValidator
 
validateTOTP(String, byte[]) - Method in class org.keycloak.models.utils.TimeBasedOTP
Validates a token using a secret key.
validateUri(URI, String, ValidationContext, Set<String>, boolean, boolean) - Method in class org.keycloak.validate.validators.UriValidator
 
validateUri(URI, Set<String>, boolean, boolean) - Method in class org.keycloak.validate.validators.UriValidator
 
ValidationContext - Class in org.keycloak.validate
Holds information about the validation state.
ValidationContext - Interface in org.keycloak.authentication
Interface that encapsulates the current validation that is being performed.
ValidationContext<T> - Interface in org.keycloak.validation
 
ValidationContext() - Constructor for class org.keycloak.validate.ValidationContext
Creates a new ValidationContext without a KeycloakSession.
ValidationContext(KeycloakSession) - Constructor for class org.keycloak.validate.ValidationContext
Creates a new ValidationContext with a KeycloakSession.
ValidationContext(KeycloakSession, Set<ValidationError>) - Constructor for class org.keycloak.validate.ValidationContext
Creates a new ValidationContext.
ValidationContext.Event - Enum in org.keycloak.validation
 
validationError(MultivaluedMap<String, String>, List<FormMessage>) - Method in interface org.keycloak.authentication.ValidationContext
Mark this validation as having a validation error
ValidationError - Class in org.keycloak.validate
Denotes an error found during validation.
ValidationError - Class in org.keycloak.validation
 
ValidationError(String, String, String) - Constructor for class org.keycloak.validate.ValidationError
 
ValidationError(String, String, String, Object...) - Constructor for class org.keycloak.validate.ValidationError
 
ValidationError(String, String, String, Object[]) - Constructor for class org.keycloak.validation.ValidationError
 
ValidationException - Exception in org.keycloak.userprofile
 
ValidationException() - Constructor for exception org.keycloak.userprofile.ValidationException
 
ValidationException.Error - Class in org.keycloak.userprofile
 
ValidationResult - Class in org.keycloak.validate
Denotes the result of a validation.
ValidationResult - Class in org.keycloak.validation
 
ValidationResult(Set<ValidationError>) - Constructor for class org.keycloak.validate.ValidationResult
Creates a new ValidationResult from the given errors.
ValidationResult(Set<ValidationError>) - Constructor for class org.keycloak.validation.ValidationResult
 
ValidationUtil - Class in org.keycloak.validation
 
ValidationUtil() - Constructor for class org.keycloak.validation.ValidationUtil
 
ValidationUtil.ErrorHandler - Interface in org.keycloak.validation
 
validator(String) - Method in class org.keycloak.validate.ValidationContext
Eases access to Validator's for nested validation.
validator(String) - Method in class org.keycloak.validate.Validators
Look-up for a built-in or registered Validator with the given provider id.
validator(KeycloakSession, String) - Static method in class org.keycloak.validate.Validators
Look-up up for a built-in or registered Validator with the given validatorId.
Validator - Interface in org.keycloak.validate
Validates given input in a ValidationContext.
Validator<T> - Interface in org.keycloak.validation
 
ValidatorConfig - Class in org.keycloak.validate
A typed wrapper around a Map based Validator configuration.
ValidatorConfig(Map<String, Object>) - Constructor for class org.keycloak.validate.ValidatorConfig
Creates a new ValidatorConfig from the given map.
ValidatorConfig.ValidatorConfigBuilder - Class in org.keycloak.validate
 
ValidatorConfigBuilder() - Constructor for class org.keycloak.validate.ValidatorConfig.ValidatorConfigBuilder
 
validatorConfigValidator() - Static method in class org.keycloak.validate.Validators
 
ValidatorConfigValidator - Class in org.keycloak.validate.validators
Validate that input value is ValidatorConfig and it is correct for validator (inputHint must be ID of the validator config is for) by Validators.validateConfig(org.keycloak.models.KeycloakSession, String, ValidatorConfig).
validatorFactory(String) - Method in class org.keycloak.validate.Validators
Look-up for a built-in or registered ValidatorFactory with the given provider id.
validatorFactory(KeycloakSession, String) - Static method in class org.keycloak.validate.Validators
Look-up for a built-in or registered ValidatorFactory with the given validatorId.
ValidatorFactory - Interface in org.keycloak.validate
A factory for custom Validator implementations plugged-in through this SPI.
Validators - Class in org.keycloak.validate
Facade for Validation functions with support for Validator implementation lookup by id.
Validators(KeycloakSession) - Constructor for class org.keycloak.validate.Validators
Creates a new Validators instance with the given KeycloakSession.
ValidatorSPI - Class in org.keycloak.validate
An Spi for custom Validator implementations.
ValidatorSPI() - Constructor for class org.keycloak.validate.ValidatorSPI
 
validOTP(String, OTPCredentialModel, int) - Static method in class org.keycloak.models.utils.CredentialValidation
 
valueOf(String) - Static method in enum org.keycloak.authentication.AuthenticationFlowError
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authentication.FlowStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authentication.InitiatedActionSupport
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authentication.RequiredActionContext.KcActionStatus
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.PermissionTicket.FilterOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.model.Policy.FilterOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.model.Resource.FilterOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.authorization.model.Scope.FilterOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.cluster.ClusterProvider.DCNotify
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.admin.OperationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.admin.ResourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.events.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.exportimport.Strategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.exportimport.UsersExportStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.forms.account.AccountPages
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.forms.login.LoginFormsPages
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.BrowserSecurityHeaders
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.dblock.DBLockProvider.Namespace
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.ImpersonationSessionNote
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.models.utils.DefaultRequiredActions.Action
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.clientpolicy.ClientPolicyVote
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.
valueOf(String) - Static method in enum org.keycloak.userprofile.UserProfileContext
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.utils.OCSPProvider.RevocationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.keycloak.validation.ValidationContext.Event
Returns the enum constant of this type with the specified name.
valueOfInteger(Integer) - Static method in enum org.keycloak.events.admin.OperationType
 
valueOfInteger(Integer) - Static method in enum org.keycloak.events.EventType
 
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.InitiatedActionSupport
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.KcActionStatus
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.PermissionTicket.FilterOption
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.FilterOption
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.Resource.FilterOption
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.Scope.FilterOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.cluster.ClusterProvider.DCNotify
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.admin.OperationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.admin.ResourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.events.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.exportimport.Strategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.exportimport.UsersExportStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.forms.account.AccountPages
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.forms.login.LoginFormsPages
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.BrowserSecurityHeaders
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.dblock.DBLockProvider.Namespace
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.models.ImpersonationSessionNote
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.DefaultRequiredActions.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.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.clientpolicy.ClientPolicyVote
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.
values() - Static method in enum org.keycloak.userprofile.UserProfileContext
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.utils.OCSPProvider.RevocationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.keycloak.validation.ValidationContext.Event
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
 
verifier(String) - Method in interface org.keycloak.crypto.SignatureProvider
 
verifier(KeyWrapper) - Method in interface org.keycloak.crypto.SignatureProvider
 
verifier(ClientModel, JWSInput) - Method in interface org.keycloak.crypto.ClientSignatureVerifierProvider
 
verify(String, String) - Method in class org.keycloak.models.utils.SHAPasswordEncoder
 
verify(String, PasswordCredentialModel) - Method in class org.keycloak.credential.hash.Pbkdf2PasswordHashProvider
 
VERIFY_EMAIL - org.keycloak.events.EventType
 
VERIFY_EMAIL - org.keycloak.models.utils.DefaultRequiredActions.Action
 
VERIFY_EMAIL_ERROR - org.keycloak.events.EventType
 
VERIFY_EMAIL_KEY - Static variable in class org.keycloak.models.Constants
 
VERIFY_PROFILE - org.keycloak.events.EventType
 
VERIFY_PROFILE_ERROR - org.keycloak.events.EventType
 
VIEW_APPLICATIONS - Static variable in interface org.keycloak.models.AccountRoles
 
VIEW_AUTHORIZATION - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_CLIENTS - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_CONSENT - Static variable in interface org.keycloak.models.AccountRoles
 
VIEW_EVENTS - Static variable in class org.keycloak.models.AdminRoles
 
VIEW_GROUPS - Static variable in interface org.keycloak.models.AccountRoles
 
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(DBLockProvider.Namespace) - Method in interface org.keycloak.models.dblock.DBLockProvider
Try to retrieve DB lock or wait if retrieve was unsuccessful.
WEBAUTHN_PASSWORDLESS_PREFIX - Static variable in class org.keycloak.models.Constants
 
WEBAUTHN_PASSWORDLESS_REGISTER - org.keycloak.models.utils.DefaultRequiredActions.Action
 
WEBAUTHN_REGISTER - org.keycloak.models.utils.DefaultRequiredActions.Action
 
WEBSITE - Static variable in class org.keycloak.models.ClaimMask
 
WILDCARD - org.keycloak.truststore.HostnameVerificationPolicy
Allows wildcards in subdomain names i.e.
WithId(String, Supplier<ClientModel>) - Constructor for class org.keycloak.models.delegate.ClientModelLazyDelegate.WithId
 
WithId(KeycloakSession, RealmModel, String) - Constructor for class org.keycloak.models.delegate.ClientModelLazyDelegate.WithId
 
writeToOutputStream(ExportAdapter.ConsumerOfOutputStream) - Method in interface org.keycloak.exportimport.ExportAdapter
Write to the output stream.

X

X_CONTENT_TYPE_OPTIONS - org.keycloak.models.BrowserSecurityHeaders
 
X_FRAME_OPTIONS - org.keycloak.models.BrowserSecurityHeaders
 
X_ROBOTS_TAG - org.keycloak.models.BrowserSecurityHeaders
 
X_XSS_PROTECTION - org.keycloak.models.BrowserSecurityHeaders
 
X509_CERTIFICATE_ISSUER_DISTINGUISHED_NAME - Static variable in interface org.keycloak.events.Details
 
X509_CERTIFICATE_SERIAL_NUMBER - Static variable in interface org.keycloak.events.Details
 
X509_CERTIFICATE_SUBJECT_DISTINGUISHED_NAME - Static variable in interface org.keycloak.events.Details
 
X509_CONFIRM - org.keycloak.forms.login.LoginFormsPages
 

Y

YES - org.keycloak.services.clientpolicy.ClientPolicyVote
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes All Packages