A B C D E F G H I J K L M N O P R S T U V W X _
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractConfig - Class in org.keycloak.models
- AbstractConfig() - Constructor for class org.keycloak.models.AbstractConfig
- AbstractKeycloakTransaction - Class in org.keycloak.models
-
Handles some common transaction logic related to start, rollback-only etc.
- AbstractKeycloakTransaction() - Constructor for class org.keycloak.models.AbstractKeycloakTransaction
- AbstractKeycloakTransaction.TransactionState - Enum in org.keycloak.models
- acceptableAaguids - Variable in class org.keycloak.models.WebAuthnPolicy
- ACCOUNT - org.keycloak.theme.Theme.Type
- ACTION_TOKEN_USER_ID - Static variable in class org.keycloak.models.DefaultActionTokenKey
-
The authenticationSession note with ID of the user authenticated via the action token
- ActiveAesKey(String, SecretKey) - Constructor for class org.keycloak.models.KeyManager.ActiveAesKey
- ActiveHmacKey(String, SecretKey) - Constructor for class org.keycloak.models.KeyManager.ActiveHmacKey
- ActiveRsaKey(String, PrivateKey, PublicKey, X509Certificate) - Constructor for class org.keycloak.models.KeyManager.ActiveRsaKey
- add() - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
Add the current property, and start building the next one
- add(SynchronizationResult) - Method in class org.keycloak.storage.user.SynchronizationResult
- addAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- addAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
- addAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
- addChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
-
Automatically calls setParent() on the subGroup
- addClient(String) - Method in interface org.keycloak.models.RealmModel
- addClient(String, String) - Method in interface org.keycloak.models.RealmModel
- addClient(RealmModel, String) - Method in interface org.keycloak.models.ClientProvider
-
Adds a client with given
clientId
to the given realm. - addClient(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
ClientProvider
. - addClient(RealmModel, String, String) - Method in interface org.keycloak.models.ClientProvider
-
Adds a client with given internal ID and
clientId
to the given realm. - addClient(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
ClientProvider
. - addClientRole(ClientModel, String) - Method in interface org.keycloak.models.RoleProvider
-
Adds a client role with given
name
to the given client. - addClientRole(ClientModel, String, String) - Method in interface org.keycloak.models.RoleProvider
-
Adds a client role with given internal ID and
name
to the given client. - addClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - addClientRole(RealmModel, ClientModel, String, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - addClientScope(String) - Method in interface org.keycloak.models.RealmModel
-
Creates new client scope with the given name.
- addClientScope(String, String) - Method in interface org.keycloak.models.RealmModel
-
Creates new client scope with the given internal ID and name.
- addClientScope(ClientScopeModel, boolean) - Method in interface org.keycloak.models.ClientModel
-
Add clientScope with this client.
- addClientScope(RealmModel, String) - Method in interface org.keycloak.models.ClientScopeProvider
-
Creates new client scope with given
name
to the given realm. - addClientScope(RealmModel, String, String) - Method in interface org.keycloak.models.ClientScopeProvider
-
Creates new client scope with given internal ID and
name
to the given realm. - addClientScopes(Set<ClientScopeModel>, boolean) - Method in interface org.keycloak.models.ClientModel
-
Add clientScopes with this client.
- addClientScopes(RealmModel, ClientModel, Set<ClientScopeModel>, boolean) - Method in interface org.keycloak.models.ClientProvider
-
Assign clientScopes to the client.
- addComponentModel(ComponentModel) - Method in interface org.keycloak.models.RealmModel
-
Adds component model.
- addCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
- addConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.models.UserProvider
-
Add user consent for the user.
- addDefaultClientScope(ClientScopeModel, boolean) - Method in interface org.keycloak.models.RealmModel
-
Adds given client scope among default/optional client scopes of this realm.
- addDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
- addDefaultRole(String) - Method in interface org.keycloak.models.RoleContainerModel
-
Deprecated.Default roles are now managed by
RealmModel.getDefaultRole()
. This method will be removed. - addFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
-
Adds a federated identity link for the user within the realm
- addGrantedClientScope(ClientScopeModel) - Method in class org.keycloak.models.UserConsentModel
- addIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
- addIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
- addProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
- addReadTokenRoleOnCreate - Variable in class org.keycloak.models.IdentityProviderModel
- addRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - addRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RoleProvider
-
Adds a realm role with given
name
to the given realm. - addRealmRole(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - addRealmRole(RealmModel, String, String) - Method in interface org.keycloak.models.RoleProvider
-
Adds a realm role with given internal ID and
name
to the given realm. - addRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
- addRequiredAction(String) - Method in interface org.keycloak.models.UserModel
- addRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- addRequiredAction(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Adds a required action to the authentication session.
- addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
- addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
- addRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Adds a required action to the authentication session.
- addRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
- addRequiredCredential(String) - Method in interface org.keycloak.models.RealmModel
- addRole(String) - Method in interface org.keycloak.models.RoleContainerModel
- addRole(String, String) - Method in interface org.keycloak.models.RoleContainerModel
- addScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
- addToDefaultRoles(RoleModel) - Method in interface org.keycloak.models.RealmModel
-
Adds a role as a composite to default role of this realm.
- addTopLevelGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.GroupProvider
-
Removes parent group for the given group in the given realm.
- addTopLevelGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - addUser(RealmModel, String) - Method in interface org.keycloak.storage.user.UserRegistrationProvider
-
All storage providers that implement this interface will be looped through.
- addUser(RealmModel, String, String, boolean, boolean) - Method in interface org.keycloak.models.UserProvider
-
Adds a new user into the storage.
- addUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserLoginFailureProvider
-
Adds a
UserLoginFailureModel
for the given realm and user id. - addUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
-
Deprecated.Use
addUserLoginFailure
instead. - addWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
- ADMIN - org.keycloak.theme.Theme.Type
- ADMIN - org.keycloak.urls.UrlType
- algorithm - Variable in class org.keycloak.models.OTPPolicy
- algorithm - Variable in class org.keycloak.models.utils.HmacOTP
- allCodesUsed() - Method in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- ALLOWED_CLOCK_SKEW - Static variable in class org.keycloak.models.IdentityProviderModel
- ALTERNATIVE - org.keycloak.models.AuthenticationExecutionModel.Requirement
- ALWAYS_DISPLAY_IN_CONSOLE - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- ASSIGNED_GROUP - Static variable in class org.keycloak.models.UserModel.SearchableFields
- ASSIGNED_ROLE - Static variable in class org.keycloak.models.GroupModel.SearchableFields
-
Field for comparison with roles granted to this group.
- ASSIGNED_ROLE - Static variable in class org.keycloak.models.UserModel.SearchableFields
- asString() - Method in class org.keycloak.models.PasswordPolicy.Builder
- ATTEMPTED - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- attestationConveyancePreference - Variable in class org.keycloak.models.WebAuthnPolicy
- ATTRIBUTE - Static variable in class org.keycloak.models.ClientModel.SearchableFields
-
Search for attribute value.
- ATTRIBUTE - Static variable in class org.keycloak.models.GroupModel.SearchableFields
-
Search for attribute value.
- ATTRIBUTE - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for attribute value.
- authenticate(KeycloakSession, RealmModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Given a CredentialInput, authenticate the user.
- authenticate(RealmModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialAuthentication
- AUTHENTICATE - org.keycloak.sessions.CommonClientSessionModel.Action
- AUTHENTICATED - org.keycloak.models.CredentialValidationOutput.Status
- AuthenticatedClientSessionModel - Interface in org.keycloak.models
- AuthenticationConfigComparator() - Constructor for class org.keycloak.models.AuthenticatorConfigModel.AuthenticationConfigComparator
- AuthenticationExecutionModel - Class in org.keycloak.models
- AuthenticationExecutionModel() - Constructor for class org.keycloak.models.AuthenticationExecutionModel
- AuthenticationExecutionModel.ExecutionComparator - Class in org.keycloak.models
- AuthenticationExecutionModel.Requirement - Enum in org.keycloak.models
- AuthenticationFlowBindings - Interface in org.keycloak.models
-
Defines constants for authentication flow bindings.
- AuthenticationFlowComparator() - Constructor for class org.keycloak.models.AuthenticationFlowModel.AuthenticationFlowComparator
- AuthenticationFlowModel - Class in org.keycloak.models
- AuthenticationFlowModel() - Constructor for class org.keycloak.models.AuthenticationFlowModel
- AuthenticationFlowModel.AuthenticationFlowComparator - Class in org.keycloak.models
- AuthenticationSessionCompoundId - Class in org.keycloak.sessions
-
Allow to encode compound string to fully lookup authenticationSessionModel
- AuthenticationSessionCompoundId(String, String, String, String) - Constructor for class org.keycloak.sessions.AuthenticationSessionCompoundId
- AuthenticationSessionModel - Interface in org.keycloak.sessions
-
Represents the state of the authentication.
- AuthenticationSessionProvider - Interface in org.keycloak.sessions
- authenticationSessions() - Method in interface org.keycloak.models.KeycloakSession
- authenticatorAttachment - Variable in class org.keycloak.models.WebAuthnPolicy
- AuthenticatorConfigModel - Class in org.keycloak.models
- AuthenticatorConfigModel() - Constructor for class org.keycloak.models.AuthenticatorConfigModel
- AuthenticatorConfigModel.AuthenticationConfigComparator - Class in org.keycloak.models
- AUTHORIZATION_DETAILS - org.keycloak.rar.AuthorizationRequestSource
- AUTHORIZATION_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- AuthorizationDetails - Class in org.keycloak.rar
-
The internal Keycloak representation of a Rich Authorization Request authorization_details object, together with some extra metadata to make it easier to work with this data in other parts of the codebase.
- AuthorizationDetails(ClientScopeModel) - Constructor for class org.keycloak.rar.AuthorizationDetails
- AuthorizationDetails(ClientScopeModel, AuthorizationRequestSource, AuthorizationDetailsJSONRepresentation) - Constructor for class org.keycloak.rar.AuthorizationDetails
- AuthorizationRequestContext - Class in org.keycloak.rar
-
This context object will contain all parsed Rich Authorization Request objects, together with the internal representation that Keycloak is going to use for Scopes.
- AuthorizationRequestContext(List<AuthorizationDetails>) - Constructor for class org.keycloak.rar.AuthorizationRequestContext
- AuthorizationRequestSource - Enum in org.keycloak.rar
- avoidSameAuthenticatorRegister - Variable in class org.keycloak.models.WebAuthnPolicy
B
- BACKCHANNEL_AUTHENTICATION_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- BACKCHANNEL_TOKEN_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- BACKCHANNEL_TOKEN_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- BACKEND - org.keycloak.urls.UrlType
- Base32 - Class in org.keycloak.models.utils
-
Base32 - encodes and decodes RFC3548 Base32 (see http://www.faqs.org/rfcs/rfc3548.html )
- Base32() - Constructor for class org.keycloak.models.utils.Base32
- BASIC_AUTHENTICATION - org.keycloak.credential.CredentialTypeMetadata.Category
- begin() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- begin() - Method in interface org.keycloak.models.KeycloakTransaction
- BOOLEAN - org.keycloak.models.ClaimTypeModel.ValueType
- BOOLEAN_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- BROKER_SESSION_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- BROKER_USER_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- BROWSER_BINDING - Static variable in interface org.keycloak.models.AuthenticationFlowBindings
- build() - Static method in class org.keycloak.models.PasswordPolicy
- build() - Method in class org.keycloak.provider.ProviderConfigurationBuilder
-
Create the list.
- build(KeycloakSession) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
-
This will validate metadata and return them
- build(KeycloakSession) - Method in class org.keycloak.credential.CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder
- build(KeycloakSession) - Method in class org.keycloak.models.PasswordPolicy.Builder
- builder() - Static method in class org.keycloak.credential.CredentialTypeMetadata
- builder() - Static method in class org.keycloak.credential.CredentialTypeMetadataContext
- buildFromBackupAuthnCode(String) - Static method in class org.keycloak.models.UserCredentialModel
- buildFromBackupAuthnCode(String, String) - Static method in class org.keycloak.models.UserCredentialModel
- BUILT_IN - Static variable in class org.keycloak.models.RequiredCredentialModel
C
- category(CredentialTypeMetadata.Category) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- cekManagementAlgorithm(TokenCategory) - Method in interface org.keycloak.models.TokenManager
- CHALLENGED - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- CIBA_AUTH_REQUESTED_USER_HINT - Static variable in class org.keycloak.models.CibaConfig
- CIBA_BACKCHANNEL_AUTH_REQUEST_SIGNING_ALG - Static variable in class org.keycloak.models.CibaConfig
- CIBA_BACKCHANNEL_CLIENT_NOTIFICATION_ENDPOINT - Static variable in class org.keycloak.models.CibaConfig
- CIBA_BACKCHANNEL_TOKEN_DELIVERY_MODE - Static variable in class org.keycloak.models.CibaConfig
- CIBA_BACKCHANNEL_TOKEN_DELIVERY_MODE_PER_CLIENT - Static variable in class org.keycloak.models.CibaConfig
- CIBA_EXPIRES_IN - Static variable in class org.keycloak.models.CibaConfig
- CIBA_INTERVAL - Static variable in class org.keycloak.models.CibaConfig
- CIBA_PING_MODE - Static variable in class org.keycloak.models.CibaConfig
- CIBA_POLL_MODE - Static variable in class org.keycloak.models.CibaConfig
- CIBA_PUSH_MODE - Static variable in class org.keycloak.models.CibaConfig
- CIBA_SUPPORTED_MODES - Static variable in class org.keycloak.models.CibaConfig
- CibaConfig - Class in org.keycloak.models
- CibaConfig(RealmModel) - Constructor for class org.keycloak.models.CibaConfig
- ClaimTypeModel - Class in org.keycloak.models
- ClaimTypeModel() - Constructor for class org.keycloak.models.ClaimTypeModel
- ClaimTypeModel(String, String, boolean, ClaimTypeModel.ValueType) - Constructor for class org.keycloak.models.ClaimTypeModel
- ClaimTypeModel(ClaimTypeModel) - Constructor for class org.keycloak.models.ClaimTypeModel
- ClaimTypeModel.ValueType - Enum in org.keycloak.models
- clearAuthNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Clears all authentication note.
- clearCache() - Method in interface org.keycloak.models.ThemeManager
- clearClientNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Clears all client notes.
- clearExecutionStatus() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Clears execution status of the authentication session.
- clearFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
- clearUserSessionNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Clears all user session notes.
- CLIENT - org.keycloak.provider.InvalidationHandler.ObjectType
- CLIENT_CERT - Static variable in class org.keycloak.credential.CredentialModel
- CLIENT_CERT - Static variable in class org.keycloak.models.RequiredCredentialModel
- CLIENT_CERT - Static variable in class org.keycloak.models.UserCredentialModel
- CLIENT_ID - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- CLIENT_ID - Static variable in class org.keycloak.models.RoleModel.SearchableFields
-
If client role, ID of the client (not the clientId)
- CLIENT_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- CLIENT_INITIAL_ACCESS - Static variable in class org.keycloak.models.RealmModel.SearchableFields
-
Search for realms that have some client initial access set.
- CLIENT_LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- CLIENT_REQUEST_LOCALE - Static variable in interface org.keycloak.locale.LocaleSelectorProvider
- CLIENT_SCOPE - org.keycloak.provider.InvalidationHandler.ObjectType
- ClientInitialAccessModel - Class in org.keycloak.models
- ClientInitialAccessModel() - Constructor for class org.keycloak.models.ClientInitialAccessModel
- clientLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
- ClientLookupProvider - Interface in org.keycloak.storage.client
-
Abstraction interface for lookoup of clients by id and clientId.
- ClientModel - Interface in org.keycloak.models
- ClientModel.ClientCreationEvent - Interface in org.keycloak.models
- ClientModel.ClientIdChangeEvent - Interface in org.keycloak.models
- ClientModel.ClientProtocolUpdatedEvent - Interface in org.keycloak.models
- ClientModel.ClientRemovedEvent - Interface in org.keycloak.models
- ClientModel.ClientUpdatedEvent - Interface in org.keycloak.models
- ClientModel.SearchableFields - Class in org.keycloak.models
- clientPolicy() - Method in interface org.keycloak.models.KeycloakSession
-
Client Policy Manager
- ClientPolicyContext - Interface in org.keycloak.services.clientpolicy
-
Provides Client Policy Context.
- ClientPolicyEvent - Enum in org.keycloak.services.clientpolicy
-
Events on which client policies mechanism detects and do its operation
- ClientPolicyException - Exception in org.keycloak.services.clientpolicy
- ClientPolicyException(String) - Constructor for exception org.keycloak.services.clientpolicy.ClientPolicyException
- ClientPolicyException(String, String) - Constructor for exception org.keycloak.services.clientpolicy.ClientPolicyException
- ClientPolicyException(String, String, Throwable) - Constructor for exception org.keycloak.services.clientpolicy.ClientPolicyException
- ClientPolicyException(String, String, Response.Status) - Constructor for exception org.keycloak.services.clientpolicy.ClientPolicyException
- ClientPolicyException(String, String, Response.Status, Throwable) - Constructor for exception org.keycloak.services.clientpolicy.ClientPolicyException
- ClientPolicyManager - Interface in org.keycloak.services.clientpolicy
-
Provides a method for handling an event defined in
ClientPolicyEvent
. - ClientProvider - Interface in org.keycloak.models
-
Provider of the client records.
- clients() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- clientScopeLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
- ClientScopeLookupProvider - Interface in org.keycloak.storage.clientscope
- ClientScopeModel - Interface in org.keycloak.models
- ClientScopeModel.ClientScopeRemovedEvent - Interface in org.keycloak.models
- ClientScopeModel.SearchableFields - Class in org.keycloak.models
- ClientScopeProvider - Interface in org.keycloak.models
-
Provider of the client scopes records.
- clientScopes() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- clientScopeStorageManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Use
KeycloakSession.clientScopes()
instead - ClientSessionContext - Interface in org.keycloak.models
-
Request-scoped context object
- clientStorageManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- clone() - Method in class org.keycloak.models.PasswordPolicy.Builder
- close() - Method in interface org.keycloak.credential.CredentialProvider
- close() - Method in interface org.keycloak.models.KeycloakSession
- close() - Method in interface org.keycloak.models.KeycloakSessionFactory
- close() - Method in interface org.keycloak.models.UserProvider
- close() - Method in interface org.keycloak.models.UserSessionProvider
- close() - Method in interface org.keycloak.provider.Provider
- close() - Method in interface org.keycloak.provider.ProviderFactory
-
This is called when the server shuts down.
- close() - Method in interface org.keycloak.urls.HostnameProvider
- close() - Method in interface org.keycloak.urls.HostnameProviderFactory
- close() - Method in interface org.keycloak.vault.VaultCharSecret
-
Destroys the secret in memory by e.g.
- close() - Method in interface org.keycloak.vault.VaultRawSecret
-
Destroys the secret in memory by e.g.
- close() - Method in interface org.keycloak.vault.VaultStringSecret
-
Destroys the secret in memory by e.g.
- commit() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- commit() - Method in interface org.keycloak.models.KeycloakTransaction
- commitImpl() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- COMMON - org.keycloak.theme.Theme.Type
- CommonClientSessionModel - Interface in org.keycloak.sessions
-
Predecesor of AuthenticationSessionModel, ClientLoginSessionModel and ClientSessionModel (then action tickets).
- CommonClientSessionModel.Action - Enum in org.keycloak.sessions
- CommonClientSessionModel.ExecutionStatus - Enum in org.keycloak.sessions
- comparator - Static variable in class org.keycloak.component.PrioritizedComponentModel
- compare(OM, OM) - Method in class org.keycloak.models.OrderedModel.OrderedModelComparator
- compare(AuthenticationExecutionModel, AuthenticationExecutionModel) - Method in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
- compare(AuthenticationFlowModel, AuthenticationFlowModel) - Method in class org.keycloak.models.AuthenticationFlowModel.AuthenticationFlowComparator
- compare(AuthenticatorConfigModel, AuthenticatorConfigModel) - Method in class org.keycloak.models.AuthenticatorConfigModel.AuthenticationConfigComparator
- compare(RequiredActionProviderModel, RequiredActionProviderModel) - Method in class org.keycloak.models.RequiredActionProviderModel.RequiredActionComparator
- COMPARE_BY_NAME - Static variable in interface org.keycloak.models.GroupModel
- COMPARE_BY_NAME - Static variable in interface org.keycloak.models.RealmModel
- COMPARE_BY_USERNAME - Static variable in interface org.keycloak.models.UserModel
- compareTo(CredentialTypeMetadata) - Method in class org.keycloak.credential.CredentialTypeMetadata
- compareWith(CredentialTypeMetadata.Category) - Method in enum org.keycloak.credential.CredentialTypeMetadata.Category
- comparingByStartDateDesc() - Static method in class org.keycloak.credential.CredentialModel
- COMPONENT - org.keycloak.provider.InvalidationHandler.ObjectType
- COMPONENT_PROVIDER_TYPE - Static variable in class org.keycloak.models.RealmModel.SearchableFields
-
Search for realms that have some component with
- ComponentFactory<CreatedType,ProviderType extends Provider> - Interface in org.keycloak.component
- ComponentModel - Class in org.keycloak.component
-
Stored configuration of a User Storage provider instance.
- ComponentModel() - Constructor for class org.keycloak.component.ComponentModel
- ComponentModel(ComponentModel) - Constructor for class org.keycloak.component.ComponentModel
- ComponentValidationException - Exception in org.keycloak.component
- ComponentValidationException() - Constructor for exception org.keycloak.component.ComponentValidationException
- ComponentValidationException(String, Object...) - Constructor for exception org.keycloak.component.ComponentValidationException
- ComponentValidationException(String, Throwable) - Constructor for exception org.keycloak.component.ComponentValidationException
- ComponentValidationException(String, Throwable, boolean, boolean) - Constructor for exception org.keycloak.component.ComponentValidationException
- ComponentValidationException(Throwable) - Constructor for exception org.keycloak.component.ComponentValidationException
- COMPOSITE_ROLE - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- CONDITIONAL - org.keycloak.models.AuthenticationExecutionModel.Requirement
- config - Variable in class org.keycloak.models.IdentityProviderMapperModel
- config - Variable in class org.keycloak.models.ProtocolMapperModel
- CONFIGURE_RECOVERY_AUTHN_CODES - org.keycloak.models.UserModel.RequiredAction
- CONFIGURE_TOTP - org.keycloak.models.UserModel.RequiredAction
- ConfiguredComponent - Interface in org.keycloak.component
- ConfiguredProvider - Interface in org.keycloak.provider
- CONSENT_CLIENT_FEDERATION_LINK - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for users that have consent set for a particular client that originates in the given client provider.
- CONSENT_FOR_CLIENT - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for users that have consent set for a particular client.
- CONSENT_SCREEN_TEXT - Static variable in interface org.keycloak.models.ClientScopeModel
- CONSENT_WITH_CLIENT_SCOPE - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for users that have consent that has given client scope.
- consentRequired - Variable in class org.keycloak.models.ProtocolMapperModel
- consentText - Variable in class org.keycloak.models.ProtocolMapperModel
- contains(String) - Method in class org.keycloak.component.ComponentModel
- contains(String) - Method in class org.keycloak.models.PasswordPolicy.Builder
- CONTINUE - org.keycloak.models.CredentialValidationOutput.Status
- CORRESPONDING_SESSION_ID - Static variable in interface org.keycloak.models.UserSessionModel
-
Represents the corresponding online/offline user session.
- CORRESPONDING_SESSION_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
-
Represents the corresponding offline user session for the online user session.
- countUsersInGroups(Stream<UserModel>, Set<String>) - Static method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users from the given list of users that are in at least one of the groups given in the groups set.
- create() - Method in interface org.keycloak.models.KeycloakSessionFactory
- create() - Static method in class org.keycloak.provider.ProviderConfigurationBuilder
- create(String, String, String, String, String, String, long, String) - Static method in class org.keycloak.models.credential.WebAuthnCredentialModel
- create(String, String, String, String, String, String, long, String, Set<String>) - Static method in class org.keycloak.models.credential.WebAuthnCredentialModel
- create(KeycloakSession) - Method in interface org.keycloak.component.ComponentFactory
- create(KeycloakSession) - Method in interface org.keycloak.provider.ProviderFactory
- create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
- createAction(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- createAuthenticationSession(ClientModel) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Create a new authentication session and returns it.
- createClientInitialAccessModel(int, int) - Method in interface org.keycloak.models.RealmModel
- createClientInitialAccessModel(RealmModel, int, int) - Method in interface org.keycloak.models.RealmProvider
- createClientSession(RealmModel, ClientModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
- createCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore
- createCredential(RealmModel, UserModel, T) - Method in interface org.keycloak.credential.CredentialProvider
- createCredentialThroughProvider(CredentialModel) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Deprecated.
- createCredentialThroughProvider(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Creates a credential from the credentialModel, by looping through the providers to find a match for the type
- createFromCredentialModel(CredentialModel) - Static method in class org.keycloak.models.credential.OTPCredentialModel
- createFromCredentialModel(CredentialModel) - Static method in class org.keycloak.models.credential.PasswordCredentialModel
- createFromCredentialModel(CredentialModel) - Static method in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- createFromCredentialModel(CredentialModel) - Static method in class org.keycloak.models.credential.WebAuthnCredentialModel
- createFromPolicy(RealmModel, String) - Static method in class org.keycloak.models.credential.OTPCredentialModel
- createFromPolicy(RealmModel, String, String) - Static method in class org.keycloak.models.credential.OTPCredentialModel
- createFromValues(String, byte[], int, String) - Static method in class org.keycloak.models.credential.PasswordCredentialModel
- createFromValues(List<String>, long, String) - Static method in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- createFromValues(PasswordCredentialData, PasswordSecretData) - Static method in class org.keycloak.models.credential.PasswordCredentialModel
- createGroup(String) - Method in interface org.keycloak.models.RealmModel
- createGroup(String, String) - Method in interface org.keycloak.models.RealmModel
- createGroup(String, String, GroupModel) - Method in interface org.keycloak.models.RealmModel
- createGroup(String, GroupModel) - Method in interface org.keycloak.models.RealmModel
- createGroup(RealmModel, String) - Method in interface org.keycloak.models.GroupProvider
-
Creates a new group with the given name in the given realm.
- createGroup(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - createGroup(RealmModel, String, String) - Method in interface org.keycloak.models.GroupProvider
-
Creates a new group with the given id and name in the given realm.
- createGroup(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - createGroup(RealmModel, String, String, GroupModel) - Method in interface org.keycloak.models.GroupProvider
-
Creates a new group with the given name, id, name and parent to the given realm.
- createGroup(RealmModel, String, String, GroupModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - createGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.models.GroupProvider
-
Creates a new group with the given name and parent to the given realm.
- createGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - createHOTP(String, int, int, String) - Static method in class org.keycloak.models.credential.OTPCredentialModel
- createOfflineClientSession(AuthenticatedClientSessionModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Will automatically attach newly created offline client session to the offlineUserSession
- createOfflineUserSession(UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Newly created userSession won't contain attached AuthenticatedClientSessions
- createOrUpdateRealmLocalizationTexts(String, Map<String, String>) - Method in interface org.keycloak.models.RealmModel
-
Creates or updates the realm-specific localization texts for the given locale.
- createRealm(String) - Method in interface org.keycloak.models.RealmProvider
-
Creates new realm with the given name.
- createRealm(String, String) - Method in interface org.keycloak.models.RealmProvider
-
Created new realm with given ID and name.
- createRootAuthenticationSession(RealmModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Creates and registers a new authentication session with random ID.
- createRootAuthenticationSession(RealmModel, String) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Creates a new root authentication session specified by the provided realm and id.
- createStoredCredential(CredentialModel) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Updates a credential of the entity with an updated
CredentialModel
. - createTimeout - Variable in class org.keycloak.models.WebAuthnPolicy
- createTOTP(String, int, int, String) - Static method in class org.keycloak.models.credential.OTPCredentialModel
- createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState) - Method in interface org.keycloak.models.UserSessionProvider
- createUserSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionProvider
- CredentialAuthentication - Interface in org.keycloak.credential
-
Single purpose method that knows how to authenticate a user based on a credential type.
- CredentialInput - Interface in org.keycloak.credential
- CredentialInputUpdater - Interface in org.keycloak.credential
- CredentialInputUpdater.Streams - Interface in org.keycloak.credential
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- CredentialInputValidator - Interface in org.keycloak.credential
-
Implentations of this interface can validate CredentialInput, i.e.
- credentialManager() - Method in interface org.keycloak.models.UserModel
-
Instance of a user credential manager to validate and update the credentials of this user.
- credentialManager() - Method in class org.keycloak.models.utils.UserModelDelegate
- CredentialMetadata - Class in org.keycloak.credential
- CredentialMetadata() - Constructor for class org.keycloak.credential.CredentialMetadata
- CredentialMetadata.LocalizedMessage - Class in org.keycloak.credential
- CredentialModel - Class in org.keycloak.credential
-
Used just in cases when we want to "directly" update or retrieve the hash or salt of user credential (For example during export/import)
- CredentialModel() - Constructor for class org.keycloak.credential.CredentialModel
- CredentialProvider<T extends CredentialModel> - Interface in org.keycloak.credential
- CredentialTypeMetadata - Class in org.keycloak.credential
- CredentialTypeMetadata.Category - Enum in org.keycloak.credential
- CredentialTypeMetadata.CredentialTypeMetadataBuilder - Class in org.keycloak.credential
- CredentialTypeMetadataBuilder() - Constructor for class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- CredentialTypeMetadataContext - Class in org.keycloak.credential
- CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder - Class in org.keycloak.credential
- CredentialTypeMetadataContextBuilder() - Constructor for class org.keycloak.credential.CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder
- CredentialValidationOutput - Class in org.keycloak.models
-
Output of credential validation
- CredentialValidationOutput(UserModel, CredentialValidationOutput.Status, Map<String, String>) - Constructor for class org.keycloak.models.CredentialValidationOutput
- CredentialValidationOutput.Status - Enum in org.keycloak.models
D
- decode(String) - Static method in class org.keycloak.models.utils.Base32
-
Decodes the given Base32 String to a raw byte array.
- decode(String, Class<T>) - Method in interface org.keycloak.models.TokenManager
-
Decodes and verifies the token, or
null
if the token was invalid - decodeClientJWT(String, ClientModel, Class<T>) - Method in interface org.keycloak.models.TokenManager
- decodeClientJWT(String, ClientModel, BiConsumer<JOSE, ClientModel>, Class<T>) - Method in interface org.keycloak.models.TokenManager
- decoded(String, String, String) - Static method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- decreaseRemainingCount(ClientInitialAccessModel) - Method in interface org.keycloak.models.RealmModel
- decreaseRemainingCount(RealmModel, ClientInitialAccessModel) - Method in interface org.keycloak.models.RealmProvider
- DEFAULT - Static variable in interface org.keycloak.theme.ThemeSelectorProvider
- DEFAULT_ALGORITHM - Static variable in class org.keycloak.models.utils.HmacOTP
- DEFAULT_CIBA_POLICY_AUTH_REQUESTED_USER_HINT - Static variable in class org.keycloak.models.CibaConfig
- DEFAULT_CIBA_POLICY_EXPIRES_IN - Static variable in class org.keycloak.models.CibaConfig
- DEFAULT_CIBA_POLICY_INTERVAL - Static variable in class org.keycloak.models.CibaConfig
- DEFAULT_CIBA_POLICY_TOKEN_DELIVERY_MODE - Static variable in class org.keycloak.models.CibaConfig
- DEFAULT_ICON_CSS_CLASS - Static variable in class org.keycloak.credential.CredentialTypeMetadata
- DEFAULT_IS_REUSABLE - Static variable in class org.keycloak.models.OTPPolicy
- DEFAULT_NUMBER_DIGITS - Static variable in class org.keycloak.models.utils.HmacOTP
- DEFAULT_OAUTH2_DEVICE_CODE_LIFESPAN - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- DEFAULT_OAUTH2_DEVICE_POLLING_INTERVAL - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- DEFAULT_PAR_REQUEST_URI_LIFESPAN - Static variable in class org.keycloak.models.ParConfig
- DEFAULT_POLICY - Static variable in class org.keycloak.models.OTPPolicy
- DEFAULT_POLICY - Static variable in class org.keycloak.models.WebAuthnPolicy
- DEFAULT_V2 - Static variable in interface org.keycloak.theme.ThemeSelectorProvider
- DEFAULT_VALIDATOR - Static variable in interface org.keycloak.models.TokenManager
- DefaultActionTokenKey - Class in org.keycloak.models
- DefaultActionTokenKey() - Constructor for class org.keycloak.models.DefaultActionTokenKey
- DefaultActionTokenKey(String, String, int, UUID) - Constructor for class org.keycloak.models.DefaultActionTokenKey
- defaultValue - Variable in class org.keycloak.provider.ProviderConfigProperty
- defaultValue(Object) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
Default value that will be shown when configuring this property for the first time
- delegate - Variable in class org.keycloak.models.utils.UserModelDelegate
- deleteCredential(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialProvider
- deleteLocalizationText(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
- deleteLocalizationTextsByLocale(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
- deleteRoleMapping(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
-
Removes the given role mapping from this object.
- deleteRoleMapping(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- deleteScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
- DESCRIPTION - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- detachFromUserSession() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
-
Detaches the client session from its user session.
- DEVICE_AUTHORIZATION_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- DEVICE_TOKEN_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- DEVICE_TOKEN_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- digits - Variable in class org.keycloak.models.OTPPolicy
- DIRECT_GRANT_BINDING - Static variable in interface org.keycloak.models.AuthenticationFlowBindings
- disableCredentialType(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Disable a credential by type.
- disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputUpdater
- disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
- DISABLED - org.keycloak.models.AuthenticationExecutionModel.Requirement
- DISABLED_REASON - Static variable in interface org.keycloak.models.UserModel
- DISPLAY_ON_CONSENT_SCREEN - Static variable in interface org.keycloak.models.ClientScopeModel
- displayName(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- DYNAMIC_SCOPE_REGEXP - Static variable in interface org.keycloak.models.ClientScopeModel
E
- EMAIL - org.keycloak.theme.Theme.Type
- EMAIL - Static variable in interface org.keycloak.models.UserModel
- EMAIL - Static variable in class org.keycloak.models.UserModel.SearchableFields
- EMAIL_VERIFIED - Static variable in interface org.keycloak.models.UserModel
- EMAIL_VERIFIED - Static variable in class org.keycloak.models.UserModel.SearchableFields
- empty() - Static method in class org.keycloak.models.PasswordPolicy
- empty() - Static method in class org.keycloak.storage.user.SynchronizationResult
- ENABLED - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- ENABLED - Static variable in interface org.keycloak.models.UserModel
- ENABLED - Static variable in class org.keycloak.models.UserModel.SearchableFields
- encode(byte[]) - Static method in class org.keycloak.models.utils.Base32
-
Encodes byte array to Base32 String.
- encode(String, int) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
- encode(String, int, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
-
Deprecated.Exists due the backwards compatibility. It is recommended to use
PasswordHashProvider.encodedCredential(String, int)
} - encode(Token) - Method in interface org.keycloak.models.TokenManager
-
Encodes the supplied token
- encodeAndEncrypt(Token) - Method in interface org.keycloak.models.TokenManager
- encoded(String) - Static method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- encodedCredential(String, int) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
- encryptAlgorithm(TokenCategory) - Method in interface org.keycloak.models.TokenManager
- enlist(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
- enlistAfterCompletion(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
- enlistForClose(Provider) - Method in interface org.keycloak.models.KeycloakSession
- enlistPrepare(KeycloakTransaction) - Method in interface org.keycloak.models.KeycloakTransactionManager
- equals(Object) - Method in class org.keycloak.models.AuthenticationExecutionModel
- equals(Object) - Method in class org.keycloak.models.ClaimTypeModel
- equals(Object) - Method in class org.keycloak.models.FederatedIdentityModel
- equals(Object) - Method in class org.keycloak.models.IdentityProviderMapperModel
- equals(Object) - Method in class org.keycloak.models.ProtocolMapperModel
- equals(Object) - Method in class org.keycloak.models.utils.UserModelDelegate
- equals(Object) - Method in class org.keycloak.rar.AuthorizationDetails
- equals(Object) - Method in class org.keycloak.storage.StorageId
- EVALUATED_FALSE - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- EVALUATED_TRUE - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- EXACT - Static variable in interface org.keycloak.models.UserModel
- ExecutionComparator() - Constructor for class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
- expandCompositeRoles(Set<RoleModel>) - Static method in class org.keycloak.models.utils.RoleUtils
- expandCompositeRolesStream(Stream<RoleModel>) - Static method in class org.keycloak.models.utils.RoleUtils
- expireLocaleCookie() - Method in interface org.keycloak.locale.LocaleUpdaterProvider
- externalId(String) - Static method in class org.keycloak.storage.StorageId
F
- failed() - Static method in class org.keycloak.models.CredentialValidationOutput
- FAILED - org.keycloak.models.CredentialValidationOutput.Status
- FAILED - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- FederatedIdentityModel - Class in org.keycloak.models
- FederatedIdentityModel(String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
- FederatedIdentityModel(String, String, String, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
- FederatedIdentityModel(FederatedIdentityModel, String) - Constructor for class org.keycloak.models.FederatedIdentityModel
- FEDERATION_LINK - Static variable in class org.keycloak.models.UserModel.SearchableFields
- FIELD_RECOVERY_CODE_IN_BROWSER_FLOW - Static variable in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- FILE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- fillInStackTrace() - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
-
If
ClientPolicyException
is used to notify the event so that it needs not to have stack trace. - FINISHED - org.keycloak.models.AbstractKeycloakTransaction.TransactionState
- FIRST_NAME - Static variable in interface org.keycloak.models.UserModel
- FIRST_NAME - Static variable in class org.keycloak.models.UserModel.SearchableFields
- FORCE - org.keycloak.models.IdentityProviderMapperSyncMode
- FORCE - org.keycloak.models.IdentityProviderSyncMode
- FORCE_EXPIRED_ID - Static variable in class org.keycloak.models.PasswordPolicy
- formLabel - Variable in class org.keycloak.models.RequiredCredentialModel
- from(String) - Static method in class org.keycloak.models.DefaultActionTokenKey
- fromAuthSession(AuthenticationSessionModel) - Static method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- fromString(String) - Static method in enum org.keycloak.models.UserSessionModel.SessionPersistenceState
- FRONTEND - org.keycloak.urls.UrlType
G
- generateHOTP(String, int) - Method in class org.keycloak.models.utils.HmacOTP
- generateOTP(String, String, int, String) - Method in class org.keycloak.models.utils.HmacOTP
-
This method generates an OTP value for the given set of parameters.
- generateRawCodes() - Static method in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- generateSecret() - Static method in class org.keycloak.models.UserCredentialModel
- generateSecret(int) - Static method in class org.keycloak.models.utils.HmacOTP
- get() - Method in interface org.keycloak.vault.VaultCharSecret
-
Returns the secret enclosed in a
CharBuffer
. - get() - Method in interface org.keycloak.vault.VaultRawSecret
-
Returns the raw secret bytes.
- get() - Method in interface org.keycloak.vault.VaultStringSecret
-
Returns the secret represented as a
String
. - get(String) - Method in class org.keycloak.component.ComponentModel
- get(String) - Method in class org.keycloak.component.JsonConfigComponentModel
- get(String) - Method in class org.keycloak.models.PasswordPolicy.Builder
- get(String, boolean) - Method in class org.keycloak.component.ComponentModel
- get(String, boolean) - Method in class org.keycloak.component.JsonConfigComponentModel
- get(String, int) - Method in class org.keycloak.component.ComponentModel
- get(String, int) - Method in class org.keycloak.component.JsonConfigComponentModel
- get(String, long) - Method in class org.keycloak.component.ComponentModel
- get(String, long) - Method in class org.keycloak.component.JsonConfigComponentModel
- get(String, String) - Method in class org.keycloak.component.ComponentModel
- get(String, String) - Method in class org.keycloak.component.JsonConfigComponentModel
- getAaguid() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getAbsolutePath() - Method in class org.keycloak.models.KeycloakUriInfo
- getAbsolutePathBuilder() - Method in class org.keycloak.models.KeycloakUriInfo
- getAcceptableAaguids() - Method in class org.keycloak.models.WebAuthnPolicy
- getAccessCodeLifespan() - Method in interface org.keycloak.models.RealmModel
- getAccessCodeLifespanLogin() - Method in interface org.keycloak.models.RealmModel
- getAccessCodeLifespanUserAction() - Method in interface org.keycloak.models.RealmModel
- getAccessTokenLifespan() - Method in interface org.keycloak.models.RealmModel
- getAccessTokenLifespanForImplicitFlow() - Method in interface org.keycloak.models.RealmModel
- getAccountTheme() - Method in interface org.keycloak.models.RealmModel
- getAction() - Method in interface org.keycloak.sessions.CommonClientSessionModel
- getActionId() - Method in class org.keycloak.models.DefaultActionTokenKey
- getActionId() - Method in interface org.keycloak.models.SingleUseObjectKeyModel
- getActionTokenGeneratedByAdminLifespan() - Method in interface org.keycloak.models.RealmModel
- getActionTokenGeneratedByUserLifespan() - Method in interface org.keycloak.models.RealmModel
- getActionTokenGeneratedByUserLifespan(String) - Method in interface org.keycloak.models.RealmModel
- getActionVerificationNonce() - Method in class org.keycloak.models.DefaultActionTokenKey
- getActionVerificationNonce() - Method in interface org.keycloak.models.SingleUseObjectKeyModel
- getActiveAesKey(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getActiveClientSessionStats(RealmModel, boolean) - Method in interface org.keycloak.models.UserSessionProvider
-
Returns a summary of client sessions key is client.getId()
- getActiveHmacKey(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getActiveKey(RealmModel, KeyUse, String) - Method in interface org.keycloak.models.KeyManager
- getActiveRsaKey(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getActiveUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
- getAdded() - Method in class org.keycloak.storage.user.SynchronizationResult
- getAdditionalParameters() - Method in class org.keycloak.models.credential.dto.PasswordCredentialData
-
Returns a map of algorithm-specific settings.
- getAdditionalParameters() - Method in class org.keycloak.models.credential.dto.PasswordSecretData
- getAdminTheme() - Method in interface org.keycloak.models.RealmModel
- getAesKeys(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getAesSecretKey(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getAlgorithm() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
- getAlgorithm() - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- getAlgorithm() - Method in class org.keycloak.models.credential.dto.PasswordCredentialData
- getAlgorithm() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- getAlgorithm() - Method in class org.keycloak.models.OTPPolicy
- getAlgorithm() - Method in class org.keycloak.models.UserCredentialModel
- getAlgorithmKey() - Method in class org.keycloak.models.OTPPolicy
- getAlias() - Method in class org.keycloak.models.AuthenticationFlowModel
- getAlias() - Method in class org.keycloak.models.AuthenticatorConfigModel
- getAlias() - Method in class org.keycloak.models.IdentityProviderModel
- getAlias() - Method in class org.keycloak.models.RequiredActionProviderModel
- getAllProviders(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
- getAllRedirectUrisOfEnabledClients(RealmModel) - Method in interface org.keycloak.models.ClientProvider
-
Deprecated.Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removal
- getAlwaysDisplayInConsoleClientsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns clients which are always displayed in the admin console as a stream.
- getAlwaysDisplayInConsoleClientsStream(RealmModel) - Method in interface org.keycloak.models.ClientProvider
-
Returns a stream of clients that are expected to always show up in account console.
- getAsArray() - Method in interface org.keycloak.vault.VaultCharSecret
-
Returns the secret in its
char[]
form. - getAsArray() - Method in interface org.keycloak.vault.VaultRawSecret
-
Returns the raw secret bytes in
byte[]
form. - getAttestationConveyancePreference() - Method in class org.keycloak.models.WebAuthnPolicy
- getAttestationStatement() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getAttestationStatementFormat() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getAttribute(String) - Method in interface org.keycloak.models.ClientModel
- getAttribute(String) - Method in interface org.keycloak.models.ClientScopeModel
- getAttribute(String) - Method in interface org.keycloak.models.KeycloakSession
- getAttribute(String) - Method in interface org.keycloak.models.RealmModel
- getAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel
- getAttribute(String, Class<T>) - Method in interface org.keycloak.models.ClientSessionContext
- getAttribute(String, Class<T>) - Method in interface org.keycloak.models.KeycloakSession
- getAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel
- getAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel
- getAttributeOrDefault(String, T) - Method in interface org.keycloak.models.KeycloakSession
- getAttributes() - Method in interface org.keycloak.models.ClientModel
- getAttributes() - Method in interface org.keycloak.models.ClientScopeModel
- getAttributes() - Method in interface org.keycloak.models.GroupModel
- getAttributes() - Method in interface org.keycloak.models.RealmModel
- getAttributes() - Method in interface org.keycloak.models.RoleModel
- getAttributes() - Method in interface org.keycloak.models.UserModel
- getAttributes() - Method in class org.keycloak.models.utils.UserModelDelegate
- getAttributeStream(String) - Method in interface org.keycloak.models.GroupModel
-
Returns group attributes that match the given name as a stream.
- getAttributeStream(String) - Method in interface org.keycloak.models.RoleModel
-
Returns all role's attributes that match the given name as a stream.
- getAttributeStream(String) - Method in interface org.keycloak.models.UserModel
-
Obtains all values associated with the specified attribute name.
- getAttributeStream(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- getAuthenticatedClientSessionByClient(String) - Method in interface org.keycloak.models.UserSessionModel
-
Returns a client session for the given client UUID.
- getAuthenticatedClientSessions() - Method in interface org.keycloak.models.UserSessionModel
-
Returns map where key is ID of the client (its UUID) and value is ID respective
AuthenticatedClientSessionModel
object. - getAuthenticatedUser() - Method in class org.keycloak.models.CredentialValidationOutput
- getAuthenticatedUser() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Returns authenticated user that is associated to the authentication session.
- getAuthenticationExecutionByFlowId(String) - Method in interface org.keycloak.models.RealmModel
- getAuthenticationExecutionById(String) - Method in interface org.keycloak.models.RealmModel
- getAuthenticationExecutionsStream(String) - Method in interface org.keycloak.models.RealmModel
-
Returns sorted (according to priority)
AuthenticationExecutionModel
as a stream. - getAuthenticationFlowBindingOverride(String) - Method in interface org.keycloak.models.ClientModel
-
Get authentication flow binding override for this client.
- getAuthenticationFlowBindingOverrides() - Method in interface org.keycloak.models.ClientModel
- getAuthenticationFlowById(String) - Method in interface org.keycloak.models.RealmModel
- getAuthenticationFlowsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns authentications flows as a stream.
- getAuthenticationSession() - Method in interface org.keycloak.models.KeycloakContext
-
Get current AuthenticationSessionModel, can be null out of the AuthenticationSession context.
- getAuthenticationSession(ClientModel, String) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Returns an authentication session for the particular client and tab or null if it doesn't yet exists.
- getAuthenticationSessions() - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Returns authentication sessions for the root authentication session.
- getAuthenticator() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getAuthenticatorAttachment() - Method in class org.keycloak.models.WebAuthnPolicy
- getAuthenticatorConfig() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getAuthenticatorConfigByAlias(String) - Method in interface org.keycloak.models.RealmModel
- getAuthenticatorConfigById(String) - Method in interface org.keycloak.models.RealmModel
- getAuthenticatorConfigsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns authentication configs as a stream.
- getAuthMethod() - Method in interface org.keycloak.models.UserSessionModel
- getAuthNote(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Retrieves value of the given authentication note to the given value.
- getAuthorizationDetailEntries() - Method in class org.keycloak.rar.AuthorizationRequestContext
- getAuthorizationDetails() - Method in class org.keycloak.rar.AuthorizationDetails
- getAuthorizationRequestContext() - Method in interface org.keycloak.models.ClientSessionContext
- getAuthRequestedUserHint() - Method in class org.keycloak.models.CibaConfig
- getAuthServerUrl() - Method in interface org.keycloak.models.KeycloakContext
- getAuthStatus() - Method in class org.keycloak.models.CredentialValidationOutput
- getBackchannelAuthRequestSigningAlg(ClientModel) - Method in class org.keycloak.models.CibaConfig
- getBackchannelClientNotificationEndpoint(ClientModel) - Method in class org.keycloak.models.CibaConfig
- getBackchannelTokenDeliveryMode() - Method in class org.keycloak.models.CibaConfig
- getBackchannelTokenDeliveryMode(ClientModel) - Method in class org.keycloak.models.CibaConfig
- getBaseUri() - Method in class org.keycloak.models.KeycloakUriInfo
- getBaseUriBuilder() - Method in class org.keycloak.models.KeycloakUriInfo
- getBaseUrl() - Method in interface org.keycloak.models.ClientModel
- getBrokerSessionId() - Method in interface org.keycloak.models.UserSessionModel
-
If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession
- getBrokerUserId() - Method in interface org.keycloak.models.UserSessionModel
- getBrowserFlow() - Method in interface org.keycloak.models.RealmModel
- getBrowserSecurityHeaders() - Method in interface org.keycloak.models.RealmModel
- getCategory() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getCertificate() - Method in class org.keycloak.keys.RsaKeyMetadata
- getCertificate() - Method in class org.keycloak.models.KeyManager.ActiveRsaKey
- getChallengeResponse() - Method in interface org.keycloak.credential.CredentialInput
- getChallengeResponse() - Method in class org.keycloak.models.UserCredentialModel
- getCharSecret(String) - Method in interface org.keycloak.vault.VaultTranscriber
-
Obtains the secret represented as a
VaultCharSecret
from the vault that matches the entry in the specified value string. - getCibaPolicy() - Method in interface org.keycloak.models.RealmModel
- getClient() - Method in interface org.keycloak.models.ClientModel.ClientProtocolUpdatedEvent
- getClient() - Method in interface org.keycloak.models.ClientModel.ClientRemovedEvent
- getClient() - Method in interface org.keycloak.models.KeycloakContext
- getClient() - Method in class org.keycloak.models.UserConsentModel
- getClient() - Method in interface org.keycloak.sessions.CommonClientSessionModel
- getClientAuthenticationFlow() - Method in interface org.keycloak.models.RealmModel
- getClientAuthenticatorType() - Method in interface org.keycloak.models.ClientModel
- getClientByClientId(String) - Method in interface org.keycloak.models.RealmModel
- getClientByClientId(RealmModel, String) - Method in interface org.keycloak.storage.client.ClientLookupProvider
-
Exact search for a client by its public client identifier.
- getClientById(String) - Method in interface org.keycloak.models.RealmModel
- getClientById(RealmModel, String) - Method in interface org.keycloak.storage.client.ClientLookupProvider
-
Exact search for a client by its internal ID.
- getClientId() - Method in interface org.keycloak.models.ClientModel
-
Returns client ID as defined by the user.
- getClientId() - Method in interface org.keycloak.models.RoleModel.RoleNameChangeEvent
- getClientInitialAccesses() - Method in interface org.keycloak.models.RealmModel
- getClientInitialAccessModel(String) - Method in interface org.keycloak.models.RealmModel
- getClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
- getClientNote(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Retrieves value of the given client note to the given value.
- getClientNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Retrieves the (name, value) map of client notes.
- getClientOfflineSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
- getClientOfflineSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
- getClientPolicies(RealmModel) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when getting client policies via Admin REST API, returns the existing client policies set on the realm.
- getClientProfiles(RealmModel, boolean) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.
- getClientRole(ClientModel, String) - Method in interface org.keycloak.storage.role.RoleLookupProvider
-
Exact search for a client role by given name.
- getClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getClientRoleMappingsStream(ClientModel) - Method in interface org.keycloak.models.RoleMapperModel
-
Returns stream of client roles that are directly set to this object for the given client.
- getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- getClientRoles(RealmModel, ClientModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getClientRoles(RealmModel, ClientModel, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getClientRolesStream(ClientModel) - Method in interface org.keycloak.models.RoleProvider
-
Returns all the client roles of the given client.
- getClientRolesStream(ClientModel, Integer, Integer) - Method in interface org.keycloak.models.RoleProvider
-
Returns the client roles of the given client.
- getClientScope() - Method in interface org.keycloak.models.ClientScopeModel.ClientScopeRemovedEvent
- getClientScope() - Method in class org.keycloak.rar.AuthorizationDetails
- getClientScopeById(String) - Method in interface org.keycloak.models.RealmModel
- getClientScopeById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
ClientScopeProvider
. - getClientScopeById(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
ClientScopeProvider
. - getClientScopeById(RealmModel, String) - Method in interface org.keycloak.storage.clientscope.ClientScopeLookupProvider
-
Exact search for a client scope by its internal ID..
- getClientScopeIds() - Method in interface org.keycloak.models.ClientSessionContext
- getClientScopes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Gets client scope IDs from the authentication session.
- getClientScopes(boolean) - Method in interface org.keycloak.models.ClientModel
-
Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
- getClientScopes(RealmModel, ClientModel, boolean) - Method in interface org.keycloak.storage.client.ClientLookupProvider
-
Return all default scopes (if
defaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the client - getClientScopesStream() - Method in interface org.keycloak.models.ClientSessionContext
-
Returns client scopes as a stream.
- getClientScopesStream() - Method in interface org.keycloak.models.RealmModel
-
Returns all client scopes of this realm as a stream.
- getClientScopesStream(RealmModel) - Method in interface org.keycloak.models.ClientScopeProvider
-
Returns all the client scopes of the given realm as a stream.
- getClientsCount() - Method in interface org.keycloak.models.RealmModel
- getClientsCount(RealmModel) - Method in interface org.keycloak.models.ClientProvider
-
Returns number of clients in the given realm
- getClientsCount(RealmModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
ClientProvider
. - getClientSession() - Method in interface org.keycloak.models.ClientSessionContext
- getClientSession(UserSessionModel, ClientModel, String, boolean) - Method in interface org.keycloak.models.UserSessionProvider
- getClientSession(UserSessionModel, ClientModel, UUID, boolean) - Method in interface org.keycloak.models.UserSessionProvider
-
Deprecated.
- getClientSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
- getClientSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
- getClientsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns clients as a stream.
- getClientsStream(Integer, Integer) - Method in interface org.keycloak.models.RealmModel
-
Returns clients as a stream.
- getClientsStream(RealmModel) - Method in interface org.keycloak.models.ClientProvider
-
Returns all the clients of the given realm as a stream.
- getClientsStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.ClientProvider
-
Returns the clients of the given realm as a stream.
- getClientUUID() - Method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- getCode() - Method in interface org.keycloak.models.ScriptModel
-
Returns the actual source code of the script.
- getCodes() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesSecretData
- getCommonProviderConfigProperties() - Method in interface org.keycloak.component.ComponentFactory
-
These are config properties that are common across all implementation of this component type
- getComponent(String) - Method in interface org.keycloak.models.RealmModel
- getComponentProvider(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSession
-
Returns a component provider for a component from the realm that is relevant to this session.
- getComponentProvider(Class<T>, String, Function<KeycloakSessionFactory, ComponentModel>) - Method in interface org.keycloak.models.KeycloakSession
-
Returns a component provider for a component from the realm that is relevant to this session.
- getComponentsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns stream of component models.
- getComponentsStream(String) - Method in interface org.keycloak.models.RealmModel
-
Returns stream of ComponentModels for specific parentId.
- getComponentsStream(String, String) - Method in interface org.keycloak.models.RealmModel
-
Returns stream of ComponentModels for specific parentId and providerType.
- getCompositesStream() - Method in interface org.keycloak.models.RoleModel
-
Returns all composite roles as a stream.
- getCompositesStream(String, Integer, Integer) - Method in interface org.keycloak.models.RoleModel
-
Returns a paginated stream of composite roles of
this
role that contain given string in its name. - getConfig() - Method in class org.keycloak.component.ComponentModel
- getConfig() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use
CredentialModel.getCredentialData()
instead and use the subtype of CredentialData specific to your credential - getConfig() - Method in class org.keycloak.models.AuthenticatorConfigModel
- getConfig() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getConfig() - Method in class org.keycloak.models.IdentityProviderModel
- getConfig() - Method in class org.keycloak.models.ProtocolMapperModel
- getConfig() - Method in class org.keycloak.models.RequiredActionProviderModel
- getConfig() - Method in interface org.keycloak.provider.ConfiguredProvider
-
Returns a default configuration for this provider.
- getConfigMap(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
- getConfigMetadata() - Method in interface org.keycloak.provider.ProviderFactory
-
Returns the metadata for each configuration property supported by this factory.
- getConfigProperties() - Method in interface org.keycloak.provider.ConfiguredProvider
- getConfigProperties(RealmModel, ComponentModel) - Method in interface org.keycloak.component.SubComponentFactory
- getConfiguredUserStorageCredentialTypesStream() - Method in interface org.keycloak.models.SubjectCredentialManager
-
Deprecated.
- getConfiguredUserStorageCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.
- getConnection() - Method in interface org.keycloak.models.KeycloakContext
- getConsentByClient(RealmModel, String, String) - Method in interface org.keycloak.models.UserProvider
-
Returns UserConsentModel given by a user with the userId for the client with clientInternalId
- getConsentScreenText() - Method in interface org.keycloak.models.ClientModel
- getConsentScreenText() - Method in interface org.keycloak.models.ClientScopeModel
- getConsentsStream(RealmModel, String) - Method in interface org.keycloak.models.UserProvider
-
Obtains the consents associated with the user identified by the specified
userId
. - getContainer() - Method in interface org.keycloak.models.RoleModel
- getContainerId() - Method in interface org.keycloak.models.RoleModel
- getContext() - Method in interface org.keycloak.models.KeycloakSession
- getContextObject(Class<T>) - Method in interface org.keycloak.models.KeycloakContext
- getContextPath() - Method in interface org.keycloak.models.KeycloakContext
- getContextPath(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the context-path for Keycloak This is useful when Keycloak is exposed on a different context-path on a reverse proxy.
- getContextPath(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the context-path for Keycloak.
- getCount() - Method in class org.keycloak.models.ClientInitialAccessModel
- getCounter() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
- getCounter() - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- getCounter() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getCreateAction() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getCreatedClient() - Method in interface org.keycloak.models.ClientModel.ClientCreationEvent
- getCreatedDate() - Method in class org.keycloak.credential.CredentialModel
- getCreatedDate() - Method in class org.keycloak.models.UserConsentModel
- getCreatedRealm() - Method in interface org.keycloak.models.RealmModel.RealmCreationEvent
- getCreatedRealm() - Method in interface org.keycloak.models.RealmModel.RealmPostCreateEvent
- getCreatedTimestamp() - Method in interface org.keycloak.models.UserModel
-
Get timestamp of user creation.
- getCreatedTimestamp() - Method in class org.keycloak.models.utils.UserModelDelegate
- getCreateTimeout() - Method in class org.keycloak.models.WebAuthnPolicy
- getCredentialData() - Method in class org.keycloak.credential.CredentialModel
- getCredentialFromModel(CredentialModel) - Method in interface org.keycloak.credential.CredentialProvider
- getCredentialId() - Method in interface org.keycloak.credential.CredentialInput
- getCredentialId() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getCredentialId() - Method in class org.keycloak.models.UserCredentialModel
- getCredentialMetadata(T, CredentialTypeMetadata) - Method in interface org.keycloak.credential.CredentialProvider
- getCredentialModel() - Method in class org.keycloak.credential.CredentialMetadata
- getCredentialPublicKey() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getCredentialTypeMetadata(CredentialTypeMetadataContext) - Method in interface org.keycloak.credential.CredentialProvider
- getCurrentRefreshToken() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getCurrentRefreshTokenUseCount() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getDaysToExpirePassword() - Method in class org.keycloak.models.PasswordPolicy
- getDeepUserRoleMappings(UserModel) - Static method in class org.keycloak.models.utils.RoleUtils
- getDefaultClientScopesStream(boolean) - Method in interface org.keycloak.models.RealmModel
-
Returns default client scopes of this realm either default ones or optional ones.
- getDefaultCredential(KeycloakSession, RealmModel, UserModel) - Method in interface org.keycloak.credential.CredentialProvider
- getDefaultGroupsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns default groups as a stream.
- getDefaultLocale() - Method in interface org.keycloak.models.RealmModel
- getDefaultRole() - Method in interface org.keycloak.models.RealmModel
-
Returns default realm role.
- getDefaultRoles() - Method in interface org.keycloak.models.RoleContainerModel
-
Deprecated.Default roles are now managed by
RealmModel.getDefaultRole()
. This method will be removed. - getDefaultRolesStream() - Method in interface org.keycloak.models.RoleContainerModel
-
Deprecated.Default roles are now managed by
RealmModel.getDefaultRole()
. This method will be removed. - getDefaultSignatureAlgorithm() - Method in interface org.keycloak.models.RealmModel
- getDefaultThemeName(Theme.Type) - Method in interface org.keycloak.theme.ThemeSelectorProvider
- getDefaultValue() - Method in class org.keycloak.provider.ProviderConfigProperty
-
Default value for the variable
- getDelegate() - Method in class org.keycloak.models.KeycloakUriInfo
- getDelegate() - Method in class org.keycloak.models.utils.UserModelDelegate
- getDescription() - Method in class org.keycloak.models.AuthenticationFlowModel
- getDescription() - Method in interface org.keycloak.models.ClientModel
- getDescription() - Method in interface org.keycloak.models.ClientScopeModel
- getDescription() - Method in interface org.keycloak.models.RoleModel
- getDescription() - Method in interface org.keycloak.models.ScriptModel
-
Returns the description of the script.
- getDevice() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
- getDevice() - Method in class org.keycloak.models.UserCredentialModel
- getDigits() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
- getDigits() - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- getDigits() - Method in class org.keycloak.models.OTPPolicy
- getDirectGrantFlow() - Method in interface org.keycloak.models.RealmModel
- getDisableableCredentialTypesStream() - Method in interface org.keycloak.models.SubjectCredentialManager
-
List the credentials that can be disabled, for example, to show the list to the entity (aka user) or an admin.
- getDisableableCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.credential.CredentialInputUpdater
-
Obtains the set of credential types that can be disabled via
disableCredentialType
. - getDisableableCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.
- getDisplayIconClasses() - Method in class org.keycloak.models.IdentityProviderModel
- getDisplayName() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getDisplayName() - Method in class org.keycloak.models.IdentityProviderModel
- getDisplayName() - Method in interface org.keycloak.models.RealmModel
- getDisplayNameHtml() - Method in interface org.keycloak.models.RealmModel
- getDockerAuthenticationFlow() - Method in interface org.keycloak.models.RealmModel
- getDuplicateFieldName() - Method in exception org.keycloak.models.ModelDuplicateException
- getDynamicClientScope(String) - Method in interface org.keycloak.models.ClientModel
-
Returns a
ClientScopeModel
associated with this client. - getDynamicScopeParam() - Method in class org.keycloak.rar.AuthorizationDetails
-
Returns the Dynamic Scope parameter from the underlying
AuthorizationDetailsJSONRepresentation
representation - getDynamicScopeRegexp() - Method in interface org.keycloak.models.ClientScopeModel
- getEmail() - Method in interface org.keycloak.models.UserModel
- getEmail() - Method in class org.keycloak.models.utils.UserModelDelegate
- getEmailTheme() - Method in interface org.keycloak.models.RealmModel
- getEnabledEventTypesStream() - Method in interface org.keycloak.models.RealmModel
-
Returns enabled event types as a stream.
- getEncodedHashedValue() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodeRepresentation
- getEncodedId() - Method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- getError() - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- getErrorDetail() - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- getErrorStatus() - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- getEvent() - Method in interface org.keycloak.services.clientpolicy.ClientPolicyContext
-
returns
ClientPolicyEvent
of client policy related events. - getEventsExpiration() - Method in interface org.keycloak.models.RealmModel
- getEventsListenersStream() - Method in interface org.keycloak.models.RealmModel
-
Returns events listeners as a stream.
- getExecutionStatus() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Returns execution status of the authentication session.
- getExpiration() - Method in class org.keycloak.models.ClientInitialAccessModel
- getExpiration() - Method in interface org.keycloak.models.SingleUseObjectKeyModel
-
Returns absolute number of seconds since the epoch in UTC timezone when the token expires.
- getExpiredPasswords() - Method in class org.keycloak.models.PasswordPolicy
- getExpiresIn() - Method in class org.keycloak.models.CibaConfig
- getExternalId() - Method in class org.keycloak.storage.StorageId
- getFailed() - Method in class org.keycloak.storage.user.SynchronizationResult
- getFailedLoginNotBefore() - Method in interface org.keycloak.models.UserLoginFailureModel
- getFailureFactor() - Method in interface org.keycloak.models.RealmModel
- getFederatedIdentitiesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserProvider
-
Obtains the federated identities of the specified user.
- getFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider
-
Returns details of the association between the user and the socialProvider.
- getFederationLink() - Method in interface org.keycloak.models.UserModel
- getFederationLink() - Method in class org.keycloak.models.utils.UserModelDelegate
- getFieldType() - Method in class org.keycloak.storage.SearchableModelField
- getFirstAttribute(String) - Method in interface org.keycloak.models.GroupModel
- getFirstAttribute(String) - Method in interface org.keycloak.models.RoleModel
- getFirstAttribute(String) - Method in interface org.keycloak.models.UserModel
- getFirstAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- getFirstBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
- getFirstName() - Method in interface org.keycloak.models.UserModel
- getFirstName() - Method in class org.keycloak.models.utils.UserModelDelegate
- getFlowByAlias(String) - Method in interface org.keycloak.models.RealmModel
- getFlowId() - Method in class org.keycloak.models.AuthenticationExecutionModel
-
If this execution is a flow, this is the flowId pointing to an AuthenticationFlowModel
- getFormLabel() - Method in class org.keycloak.models.RequiredCredentialModel
- getGrantedClientScopes() - Method in class org.keycloak.models.UserConsentModel
- getGroup() - Method in interface org.keycloak.models.GroupModel.GroupRemovedEvent
- getGroupById(String) - Method in interface org.keycloak.models.RealmModel
- getGroupById(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - getGroupById(RealmModel, String) - Method in interface org.keycloak.storage.group.GroupLookupProvider
-
Returns a group from the given realm with the corresponding id
- getGroupMembersStream(RealmModel, GroupModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Obtains users that belong to a specific group.
- getGroupMembersStream(RealmModel, GroupModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Obtains users that belong to a specific group.
- getGroupsByRoleStream(RealmModel, RoleModel, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider
-
Returns groups with the given role in the given realm.
- getGroupsCount() - Method in interface org.keycloak.models.UserModel
- getGroupsCount(Boolean) - Method in interface org.keycloak.models.RealmModel
- getGroupsCount(RealmModel, Boolean) - Method in interface org.keycloak.models.GroupProvider
-
Returns a number of groups/top level groups (i.e.
- getGroupsCount(RealmModel, Boolean) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - getGroupsCount(RealmModel, Stream<String>, String) - Method in interface org.keycloak.models.GroupProvider
-
Returns a number of groups that contains the search string in the name
- getGroupsCountByNameContaining(String) - Method in interface org.keycloak.models.RealmModel
- getGroupsCountByNameContaining(String) - Method in interface org.keycloak.models.UserModel
- getGroupsCountByNameContaining(RealmModel, String) - Method in interface org.keycloak.models.GroupProvider
-
Returns the number of top level groups containing groups with the given string in name for the given realm.
- getGroupsCountByNameContaining(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - getGroupsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns groups as a stream.
- getGroupsStream() - Method in interface org.keycloak.models.UserModel
-
Obtains the groups associated with the user.
- getGroupsStream() - Method in class org.keycloak.models.utils.UserModelDelegate
- getGroupsStream(String, Integer, Integer) - Method in interface org.keycloak.models.UserModel
-
Returns a paginated stream of groups within this realm with search in the name
- getGroupsStream(RealmModel) - Method in interface org.keycloak.models.GroupProvider
-
Returns groups for the given realm.
- getGroupsStream(RealmModel, Stream<String>) - Method in interface org.keycloak.models.GroupProvider
-
Returns a stream of groups with given ids.
- getGroupsStream(RealmModel, Stream<String>, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider
-
Returns a paginated stream of groups with given ids.
- getGroupsStream(RealmModel, Stream<String>, String, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider
-
Returns a paginated stream of groups with given ids and given search value in group names.
- getGuiOrder() - Method in interface org.keycloak.models.ClientScopeModel
- getGuiOrder() - Method in interface org.keycloak.models.OrderedModel
- getHashAlgorithm() - Method in class org.keycloak.models.PasswordPolicy
- getHashIterations() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
- getHashIterations() - Method in class org.keycloak.models.credential.dto.PasswordCredentialData
- getHashIterations() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- getHashIterations() - Method in class org.keycloak.models.PasswordPolicy
- getHelpText() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getHelpText() - Method in interface org.keycloak.provider.ConfiguredProvider
- getHelpText() - Method in class org.keycloak.provider.ProviderConfigProperty
-
Help text that will be displayed in the admin console tooltip
- getHmacKeys(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getHmacSecretKey(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getHostname(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the host.
- getHostname(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the host.
- getIconCssClass() - Method in class org.keycloak.credential.CredentialTypeMetadata
-
Return the icon CSS, which can be used to display icon, which represents this particular authenticator.
- getId() - Method in class org.keycloak.component.ComponentModel
- getId() - Method in class org.keycloak.component.JsonConfigComponentModel
- getId() - Method in class org.keycloak.credential.CredentialModel
- getId() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getId() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getId() - Method in class org.keycloak.models.AuthenticationFlowModel
- getId() - Method in class org.keycloak.models.AuthenticatorConfigModel
- getId() - Method in class org.keycloak.models.ClaimTypeModel
- getId() - Method in class org.keycloak.models.ClientInitialAccessModel
- getId() - Method in interface org.keycloak.models.ClientModel
-
Returns client internal ID (UUID).
- getId() - Method in interface org.keycloak.models.ClientScopeModel
- getId() - Method in interface org.keycloak.models.GroupModel
- getId() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getId() - Method in class org.keycloak.models.ProtocolMapperModel
- getId() - Method in interface org.keycloak.models.RealmModel
- getId() - Method in class org.keycloak.models.RequiredActionProviderModel
- getId() - Method in interface org.keycloak.models.RoleContainerModel
- getId() - Method in interface org.keycloak.models.RoleModel
- getId() - Method in interface org.keycloak.models.ScriptModel
-
Returns the unique id of the script.
- getId() - Method in interface org.keycloak.models.UserLoginFailureModel
- getId() - Method in interface org.keycloak.models.UserModel
- getId() - Method in interface org.keycloak.models.UserSessionModel
- getId() - Method in class org.keycloak.models.utils.UserModelDelegate
- getId() - Method in interface org.keycloak.provider.ProviderFactory
- getId() - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Returns id of the root authentication session.
- getId() - Method in class org.keycloak.storage.StorageId
- getIdentityProvider() - Method in class org.keycloak.models.FederatedIdentityModel
- getIdentityProviderAlias() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
- getIdentityProviderMapper() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getIdentityProviderMapperById(String) - Method in interface org.keycloak.models.RealmModel
- getIdentityProviderMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel
- getIdentityProviderMappersByAliasStream(String) - Method in interface org.keycloak.models.RealmModel
-
Returns identity provider mappers by the provided alias as a stream.
- getIdentityProviderMappersStream() - Method in interface org.keycloak.models.RealmModel
-
Returns identity provider mappers as a stream.
- getIdentityProvidersStream() - Method in interface org.keycloak.models.RealmModel
-
Returns identity providers as a stream.
- getImportName() - Method in interface org.keycloak.theme.Theme
- getInfoMessage() - Method in class org.keycloak.credential.CredentialMetadata
- getInitialCounter() - Method in class org.keycloak.models.OTPPolicy
- getInstance() - Static method in class org.keycloak.models.OrderedModel.OrderedModelComparator
- getInternalId() - Method in class org.keycloak.models.IdentityProviderModel
- getIpAddress() - Method in interface org.keycloak.models.UserSessionModel
- getJTAPolicy() - Method in interface org.keycloak.models.KeycloakTransactionManager
- getKey() - Method in class org.keycloak.credential.CredentialMetadata.LocalizedMessage
- getKey(RealmModel, String, KeyUse, String) - Method in interface org.keycloak.models.KeyManager
- getKeycloakSession() - Method in interface org.keycloak.models.ClientModel.ClientIdChangeEvent
- getKeycloakSession() - Method in interface org.keycloak.models.ClientModel.ClientRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.ClientModel.ClientUpdatedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.ClientScopeModel.ClientScopeRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.GroupModel.GroupPathChangeEvent
- getKeycloakSession() - Method in interface org.keycloak.models.GroupModel.GroupRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.IdentityProviderRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.IdentityProviderUpdatedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmCreationEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmPostCreateEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.RoleModel.RoleNameChangeEvent
- getKeycloakSession() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
- getKeycloakSession() - Method in interface org.keycloak.models.UserSessionProvider
-
Returns currently used Keycloak session.
- getKeycloakSessionFactory() - Method in interface org.keycloak.models.KeycloakSession
- getKeysStream(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Returns all
KeyWrapper
for the given realm. - getKeysStream(RealmModel, KeyUse, String) - Method in interface org.keycloak.models.KeyManager
-
Returns all
KeyWrapper
for the given realm that match given criteria. - getKeyURI(RealmModel, UserModel, String) - Method in class org.keycloak.models.OTPPolicy
-
Constructs the
otpauth://
URI based on the Key-Uri-Format. - getKid() - Method in class org.keycloak.keys.KeyMetadata
- getKid() - Method in class org.keycloak.models.KeyManager.ActiveAesKey
- getKid() - Method in class org.keycloak.models.KeyManager.ActiveHmacKey
- getKid() - Method in class org.keycloak.models.KeyManager.ActiveRsaKey
- getLabel() - Method in class org.keycloak.provider.ProviderConfigProperty
-
Label shown in the admin console when configuring the variable
- getLastFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
- getLastIPFailure() - Method in interface org.keycloak.models.UserLoginFailureModel
- getLastName() - Method in interface org.keycloak.models.UserModel
- getLastName() - Method in class org.keycloak.models.utils.UserModelDelegate
- getLastSessionRefresh() - Method in interface org.keycloak.models.UserSessionModel
- getLastUpdatedDate() - Method in class org.keycloak.models.UserConsentModel
- getLifespan() - Method in class org.keycloak.models.OAuth2DeviceConfig
- getLifespan(ClientModel) - Method in class org.keycloak.models.OAuth2DeviceConfig
- getLocalizationTextsById(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider
- getLoginTheme() - Method in interface org.keycloak.models.RealmModel
- getLoginUsername() - Method in interface org.keycloak.models.UserSessionModel
- getLookAheadWindow() - Method in class org.keycloak.models.OTPPolicy
- getManagementUrl() - Method in interface org.keycloak.models.ClientModel
- getMasterAdminClient() - Method in interface org.keycloak.models.RealmModel
- getMatchedResources() - Method in class org.keycloak.models.KeycloakUriInfo
- getMatchedURIs() - Method in class org.keycloak.models.KeycloakUriInfo
- getMatchedURIs(boolean) - Method in class org.keycloak.models.KeycloakUriInfo
- getMaxDeltaTimeSeconds() - Method in interface org.keycloak.models.RealmModel
- getMaxFailureWaitSeconds() - Method in interface org.keycloak.models.RealmModel
- getMessage() - Method in class org.keycloak.policy.PolicyError
- getMessages(String, Locale) - Method in interface org.keycloak.theme.Theme
-
Retrieve localized messages from a message bundle.
- getMessages(String, Locale) - Method in interface org.keycloak.theme.ThemeResourceProvider
-
Load the message bundle for the specific name and locale
- getMessages(Locale) - Method in interface org.keycloak.theme.Theme
-
Same as getMessages(baseBundlename, locale), but uses a default baseBundlename such as "messages".
- getMimeType() - Method in interface org.keycloak.models.ScriptModel
-
Returns the MIME-type if the script code, e.g.
- getMinimumQuickLoginWaitSeconds() - Method in interface org.keycloak.models.RealmModel
- getName() - Method in class org.keycloak.component.ComponentModel
- getName() - Method in class org.keycloak.component.JsonConfigComponentModel
- getName() - Method in class org.keycloak.locale.LocaleSelectorSPI
- getName() - Method in class org.keycloak.locale.LocaleUpdaterSPI
- getName() - Method in class org.keycloak.models.ClaimTypeModel
- getName() - Method in interface org.keycloak.models.ClientModel
- getName() - Method in interface org.keycloak.models.ClientScopeModel
- getName() - Method in interface org.keycloak.models.GroupModel
- getName() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getName() - Method in class org.keycloak.models.ProtocolMapperModel
- getName() - Method in interface org.keycloak.models.RealmModel
- getName() - Method in class org.keycloak.models.RequiredActionProviderModel
-
Used for display purposes.
- getName() - Method in interface org.keycloak.models.RoleModel
- getName() - Method in interface org.keycloak.models.ScriptModel
-
Returns the name of the script.
- getName() - Method in class org.keycloak.provider.ProviderConfigProperty
-
Name of the config variable stored in the database
- getName() - Method in interface org.keycloak.provider.Spi
- getName() - Method in class org.keycloak.storage.SearchableModelField
- getName() - Method in interface org.keycloak.theme.Theme
- getName() - Method in class org.keycloak.theme.ThemeResourceSpi
- getName() - Method in class org.keycloak.theme.ThemeSelectorSpi
- getName() - Method in class org.keycloak.urls.HostnameSpi
- getName() - Method in class org.keycloak.vault.VaultSpi
- getNewClientId() - Method in interface org.keycloak.models.ClientModel.ClientIdChangeEvent
- getNewName() - Method in interface org.keycloak.models.RoleModel.RoleNameChangeEvent
- getNewPath() - Method in interface org.keycloak.models.GroupModel.GroupPathChangeEvent
- getNextRecoveryAuthnCode() - Method in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- getNodeReRegistrationTimeout() - Method in interface org.keycloak.models.ClientModel
- getNotBefore() - Method in interface org.keycloak.models.ClientModel
-
Time in seconds since epoc
- getNotBefore() - Method in interface org.keycloak.models.RealmModel
-
Time in seconds since epoc
- getNotBeforeOfUser(RealmModel, UserModel) - Method in interface org.keycloak.models.UserProvider
-
Gets the notBefore value for the given user
- getNote(String) - Method in class org.keycloak.component.ComponentModel
- getNote(String) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getNote(String) - Method in interface org.keycloak.models.SingleUseObjectValueModel
-
Returns value of the given note (or
null
when no note of this name is present) - getNote(String) - Method in class org.keycloak.models.UserCredentialModel
- getNote(String) - Method in interface org.keycloak.models.UserSessionModel
- getNotes() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getNotes() - Method in interface org.keycloak.models.SingleUseObjectValueModel
-
Returns unmodifiable map of all notes.
- getNotes() - Method in interface org.keycloak.models.UserSessionModel
- getNumber() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodeRepresentation
- getNumFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
- getOAuth2DeviceConfig() - Method in interface org.keycloak.models.RealmModel
- getOfflineSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
- getOfflineSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
- getOfflineSessionsCount(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
- getOfflineUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
- getOfflineUserSessionByBrokerSessionId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
- getOfflineUserSessionByBrokerUserIdStream(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the offline user sessions associated with the user that matches the specified
brokerUserId
. - getOfflineUserSessionsStream(RealmModel, ClientModel, Integer, Integer) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the offline user sessions associated with the specified client, starting from the
firstResult
and containing at mostmaxResults
. - getOfflineUserSessionsStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the offline user sessions associated with the specified user.
- getOptions() - Method in class org.keycloak.provider.ProviderConfigProperty
-
For list types, this is a list of choices to choose from.
- getOTPCredentialData() - Method in class org.keycloak.models.credential.OTPCredentialModel
- getOTPPolicy() - Method in interface org.keycloak.models.RealmModel
- getOTPSecretData() - Method in class org.keycloak.models.credential.OTPCredentialModel
- getParameters() - Method in exception org.keycloak.component.ComponentValidationException
- getParameters() - Method in class org.keycloak.credential.CredentialMetadata.LocalizedMessage
- getParameters() - Method in exception org.keycloak.models.ModelException
- getParameters() - Method in class org.keycloak.policy.PolicyError
- getParent() - Method in interface org.keycloak.models.GroupModel
- getParentFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getParentId() - Method in class org.keycloak.component.ComponentModel
- getParentId() - Method in interface org.keycloak.models.GroupModel
- getParentName() - Method in interface org.keycloak.theme.Theme
- getParentSession() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Returns the root authentication session that is parent of this authentication session.
- getParPolicy() - Method in interface org.keycloak.models.RealmModel
- getPasswordCredentialData() - Method in class org.keycloak.models.credential.PasswordCredentialModel
- getPasswordPolicy() - Method in interface org.keycloak.models.RealmModel
- getPasswordSecretData() - Method in class org.keycloak.models.credential.PasswordCredentialModel
- getPath() - Method in class org.keycloak.models.KeycloakUriInfo
- getPath(boolean) - Method in class org.keycloak.models.KeycloakUriInfo
- getPathParameters() - Method in class org.keycloak.models.KeycloakUriInfo
- getPathParameters(boolean) - Method in class org.keycloak.models.KeycloakUriInfo
- getPathSegments() - Method in class org.keycloak.models.KeycloakUriInfo
- getPathSegments(boolean) - Method in class org.keycloak.models.KeycloakUriInfo
- getPeriod() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
- getPeriod() - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- getPeriod() - Method in class org.keycloak.models.OTPPolicy
- getPolicies() - Method in class org.keycloak.models.PasswordPolicy
- getPolicyConfig(String) - Method in class org.keycloak.models.PasswordPolicy
- getPoolingInterval() - Method in class org.keycloak.models.CibaConfig
- getPoolingInterval() - Method in class org.keycloak.models.OAuth2DeviceConfig
- getPoolingInterval(ClientModel) - Method in class org.keycloak.models.OAuth2DeviceConfig
- getPort(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the port (or -1 for default port).
- getPort(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the port (or -1 for default port).
- getPostBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel
- getPreviousClientId() - Method in interface org.keycloak.models.ClientModel.ClientIdChangeEvent
- getPreviousName() - Method in interface org.keycloak.models.RoleModel.RoleNameChangeEvent
- getPreviousPath() - Method in interface org.keycloak.models.GroupModel.GroupPathChangeEvent
- getPriority() - Method in class org.keycloak.component.PrioritizedComponentModel
- getPriority() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getPriority() - Method in class org.keycloak.models.RequiredActionProviderModel
- getPrivateKey() - Method in class org.keycloak.models.KeyManager.ActiveRsaKey
- getProperties() - Method in interface org.keycloak.theme.Theme
- getProtocol() - Method in interface org.keycloak.models.ClientModel
- getProtocol() - Method in interface org.keycloak.models.ClientScopeModel
- getProtocol() - Method in class org.keycloak.models.ProtocolMapperModel
- getProtocol() - Method in interface org.keycloak.sessions.CommonClientSessionModel
- getProtocolMapper() - Method in class org.keycloak.models.ProtocolMapperModel
- getProtocolMapperById(String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
- getProtocolMapperByName(String, String) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
- getProtocolMappersStream() - Method in interface org.keycloak.models.ClientSessionContext
-
Returns protocol mappers as a stream.
- getProtocolMappersStream() - Method in interface org.keycloak.models.ProtocolMapperContainerModel
-
Returns protocol mappers as a stream.
- getProvider(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
-
Get dedicated provider instance of provider type clazz that was created for this session.
- getProvider(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSession
-
Get dedicated provider instance for a specific provider factory of id of provider type clazz that was created for this session.
- getProvider(Class<T>, ComponentModel) - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Deprecated in favor of {@link #getComponentProvider)
- getProviderClass() - Method in class org.keycloak.locale.LocaleSelectorSPI
- getProviderClass() - Method in class org.keycloak.locale.LocaleUpdaterSPI
- getProviderClass() - Method in interface org.keycloak.provider.Spi
- getProviderClass() - Method in class org.keycloak.theme.ThemeResourceSpi
- getProviderClass() - Method in class org.keycloak.theme.ThemeSelectorSpi
- getProviderClass() - Method in class org.keycloak.urls.HostnameSpi
- getProviderClass() - Method in class org.keycloak.vault.VaultSpi
- getProviderClass(String) - Method in interface org.keycloak.models.KeycloakSession
- getProviderFactoriesStream(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory
-
Returns stream of provider factories for the given provider.
- getProviderFactory(Class<T>) - Method in interface org.keycloak.models.KeycloakSessionFactory
- getProviderFactory(Class<T>, String) - Method in interface org.keycloak.models.KeycloakSessionFactory
- getProviderFactory(Class<T>, String, String, Function<KeycloakSessionFactory, ComponentModel>) - Method in interface org.keycloak.models.KeycloakSessionFactory
- getProviderFactoryClass() - Method in class org.keycloak.locale.LocaleSelectorSPI
- getProviderFactoryClass() - Method in class org.keycloak.locale.LocaleUpdaterSPI
- getProviderFactoryClass() - Method in interface org.keycloak.provider.Spi
- getProviderFactoryClass() - Method in class org.keycloak.theme.ThemeResourceSpi
- getProviderFactoryClass() - Method in class org.keycloak.theme.ThemeSelectorSpi
- getProviderFactoryClass() - Method in class org.keycloak.urls.HostnameSpi
- getProviderFactoryClass() - Method in class org.keycloak.vault.VaultSpi
- getProviderId() - Method in class org.keycloak.component.ComponentModel
- getProviderId() - Method in class org.keycloak.component.JsonConfigComponentModel
- getProviderId() - Method in class org.keycloak.keys.KeyMetadata
- getProviderId() - Method in class org.keycloak.models.AuthenticationFlowModel
- getProviderId() - Method in class org.keycloak.models.IdentityProviderModel
- getProviderId() - Method in class org.keycloak.models.RequiredActionProviderModel
- getProviderId() - Method in class org.keycloak.storage.StorageId
- getProviderPriority() - Method in class org.keycloak.keys.KeyMetadata
- getProviderType() - Method in class org.keycloak.component.ComponentModel
- getProviderType() - Method in class org.keycloak.component.JsonConfigComponentModel
- getPublicKey() - Method in class org.keycloak.keys.RsaKeyMetadata
- getPublicKey() - Method in class org.keycloak.models.KeyManager.ActiveRsaKey
- getQueryParameters() - Method in class org.keycloak.models.KeycloakUriInfo
- getQueryParameters(boolean) - Method in class org.keycloak.models.KeycloakUriInfo
- getQuickLoginCheckMilliSeconds() - Method in interface org.keycloak.models.RealmModel
- getRawSecret(String) - Method in interface org.keycloak.vault.VaultTranscriber
-
Obtains the raw secret from the vault that matches the entry in the specified value string.
- getRealm() - Method in interface org.keycloak.models.ClientModel
- getRealm() - Method in interface org.keycloak.models.ClientScopeModel
- getRealm() - Method in interface org.keycloak.models.GroupModel.GroupPathChangeEvent
- getRealm() - Method in interface org.keycloak.models.GroupModel.GroupRemovedEvent
- getRealm() - Method in interface org.keycloak.models.KeycloakContext
- getRealm() - Method in interface org.keycloak.models.RealmModel.IdentityProviderRemovedEvent
- getRealm() - Method in interface org.keycloak.models.RealmModel.IdentityProviderUpdatedEvent
- getRealm() - Method in interface org.keycloak.models.RealmModel.RealmRemovedEvent
- getRealm() - Method in interface org.keycloak.models.RoleModel.RoleNameChangeEvent
- getRealm() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
- getRealm() - Method in interface org.keycloak.models.UserSessionModel
- getRealm() - Method in interface org.keycloak.sessions.CommonClientSessionModel
- getRealm() - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Returns realm associated to the root authentication session.
- getRealm(String) - Method in interface org.keycloak.models.RealmProvider
-
Exact search for a realm by its internal ID.
- getRealmByName(String) - Method in interface org.keycloak.models.RealmProvider
-
Exact search for a realm by its name.
- getRealmId() - Method in interface org.keycloak.models.ScriptModel
-
Returns the realm id in which the script was defined.
- getRealmLocalizationTexts() - Method in interface org.keycloak.models.RealmModel
- getRealmLocalizationTextsByLocale(String) - Method in interface org.keycloak.models.RealmModel
- getRealmRole(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getRealmRole(RealmModel, String) - Method in interface org.keycloak.storage.role.RoleLookupProvider
-
Exact search for a role by given name.
- getRealmRoleMappingsStream() - Method in interface org.keycloak.models.RoleMapperModel
-
Returns stream of realm roles that are directly set to this object.
- getRealmRoleMappingsStream() - Method in class org.keycloak.models.utils.UserModelDelegate
- getRealmRoles(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getRealmRolesStream(RealmModel) - Method in interface org.keycloak.models.RoleProvider
-
Returns all the realm roles of the given realm as a stream.
- getRealmRolesStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.RoleProvider
-
Returns the realm roles of the given realm as a stream.
- getRealmScopeMappingsStream() - Method in interface org.keycloak.models.ScopeContainerModel
-
From the scope mappings returned by
ScopeContainerModel.getScopeMappingsStream()
returns only those that belong to the realm that owns this scope container. - getRealmsStream() - Method in interface org.keycloak.models.RealmProvider
-
Returns realms as a stream.
- getRealmsWithProviderTypeStream(Class<?>) - Method in interface org.keycloak.models.RealmProvider
-
Returns stream of realms which has component with the given provider type.
- getRecoveryCodesWarningThreshold() - Method in class org.keycloak.models.PasswordPolicy
- getRedirectUri() - Method in interface org.keycloak.sessions.CommonClientSessionModel
- getRedirectUris() - Method in interface org.keycloak.models.ClientModel
- getRefreshTokenMaxReuse() - Method in interface org.keycloak.models.RealmModel
- getRegisteredNodes() - Method in interface org.keycloak.models.ClientModel
- getRegistrationFlow() - Method in interface org.keycloak.models.RealmModel
- getRegistrationToken() - Method in interface org.keycloak.models.ClientModel
- getRemainingCodes() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- getRemainingCount() - Method in class org.keycloak.models.ClientInitialAccessModel
- getRemoved() - Method in class org.keycloak.storage.user.SynchronizationResult
- getRemovedIdentityProvider() - Method in interface org.keycloak.models.RealmModel.IdentityProviderRemovedEvent
- getRequestHeaders() - Method in interface org.keycloak.models.KeycloakContext
- getRequestUri() - Method in class org.keycloak.models.KeycloakUriInfo
- getRequestUriBuilder() - Method in class org.keycloak.models.KeycloakUriInfo
- getRequestUriLifespan() - Method in class org.keycloak.models.ParConfig
- getRequiredActionProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
- getRequiredActionProviderById(String) - Method in interface org.keycloak.models.RealmModel
- getRequiredActionProvidersStream() - Method in interface org.keycloak.models.RealmModel
-
Returns sorted
RequiredActionProviderModel
as a stream. - getRequiredActions() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Returns required actions that are attached to this client session.
- getRequiredActionsStream() - Method in interface org.keycloak.models.UserModel
-
Obtains the names of required actions associated with the user.
- getRequiredActionsStream() - Method in class org.keycloak.models.utils.UserModelDelegate
- getRequiredCredentialsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns required credentials as a stream.
- getRequirement() - Method in class org.keycloak.models.AuthenticationExecutionModel
- getRequireResidentKey() - Method in class org.keycloak.models.WebAuthnPolicy
- getResetCredentialsFlow() - Method in interface org.keycloak.models.RealmModel
- getResourceAsStream(String) - Method in interface org.keycloak.theme.Theme
- getResourceAsStream(String) - Method in interface org.keycloak.theme.ThemeResourceProvider
-
Load the resource for the specific path
- getResourcesTag() - Method in interface org.keycloak.migration.MigrationModel
-
Deprecated.
- getRole() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent
- getRole(String) - Method in interface org.keycloak.models.RoleContainerModel
- getRoleById(String) - Method in interface org.keycloak.models.RealmModel
- getRoleById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - getRoleById(RealmModel, String) - Method in interface org.keycloak.storage.role.RoleLookupProvider
-
Exact search for a role by its internal ID..
- getRoleMappingsStream() - Method in interface org.keycloak.models.RoleMapperModel
-
Returns stream of all role (both realm all client) that are directly set to this object.
- getRoleMappingsStream() - Method in class org.keycloak.models.utils.UserModelDelegate
- getRoleMembersStream(RealmModel, RoleModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Obtains users that have the specified role.
- getRoleMembersStream(RealmModel, RoleModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for users that have the specified role.
- getRolesStream() - Method in interface org.keycloak.models.ClientSessionContext
-
Returns all roles including composite ones as a stream.
- getRolesStream() - Method in interface org.keycloak.models.RoleContainerModel
-
Returns available roles as a stream.
- getRolesStream(Integer, Integer) - Method in interface org.keycloak.models.RoleContainerModel
-
Returns available roles as a stream.
- getRolesStream(RealmModel, Stream<String>, String, Integer, Integer) - Method in interface org.keycloak.models.RoleProvider
-
Returns a paginated stream of roles with given ids and given search value in role names.
- getRollbackOnly() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- getRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
- getRootAuthenticationSession(RealmModel, String) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Returns the root authentication session specified by the provided realm and id.
- getRootSessionId() - Method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- getRootUrl() - Method in interface org.keycloak.models.ClientModel
- getRpEntityName() - Method in class org.keycloak.models.WebAuthnPolicy
- getRpId() - Method in class org.keycloak.models.WebAuthnPolicy
- getRsaCertificate(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getRsaKeys(RealmModel) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getRsaPublicKey(RealmModel, String) - Method in interface org.keycloak.models.KeyManager
-
Deprecated.
- getSalt() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
- getSalt() - Method in class org.keycloak.models.credential.dto.PasswordSecretData
- getScheme(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the URL scheme.
- getScheme(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider
-
Returns the URL scheme.
- getScopeMappingsStream() - Method in interface org.keycloak.models.ScopeContainerModel
-
Returns scope mappings for this scope container as a stream.
- getScopeString() - Method in interface org.keycloak.models.ClientSessionContext
- getSecret() - Method in interface org.keycloak.models.ClientModel
- getSecretData() - Method in class org.keycloak.credential.CredentialModel
- getSecretKey() - Method in class org.keycloak.models.KeyManager.ActiveAesKey
- getSecretKey() - Method in class org.keycloak.models.KeyManager.ActiveHmacKey
- getServerStartupTimestamp() - Method in interface org.keycloak.models.KeycloakSessionFactory
- getServiceAccount(ClientModel) - Method in interface org.keycloak.models.UserProvider
-
Return a UserModel representing service account of the client
- getServiceAccountClientLink() - Method in interface org.keycloak.models.UserModel
- getServiceAccountClientLink() - Method in class org.keycloak.models.utils.UserModelDelegate
- getSignatureAlgorithm() - Method in class org.keycloak.models.WebAuthnPolicy
- getSmtpConfig() - Method in interface org.keycloak.models.RealmModel
- getSource() - Method in class org.keycloak.rar.AuthorizationDetails
- getSpi(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory
- getSpis() - Method in interface org.keycloak.models.KeycloakSessionFactory
- getSslRequired() - Method in interface org.keycloak.models.RealmModel
- getSsoSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel
- getSsoSessionIdleTimeoutRememberMe() - Method in interface org.keycloak.models.RealmModel
- getSsoSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel
- getSsoSessionMaxLifespanRememberMe() - Method in interface org.keycloak.models.RealmModel
- getStableIndex() - Method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
- getStableIndex() - Method in enum org.keycloak.models.UserSessionModel.State
- getStableIndex() - Method in enum org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- getStarted() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getStarted() - Method in interface org.keycloak.models.UserSessionModel
- getStartupTime(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
- getState() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- getState() - Method in class org.keycloak.models.CredentialValidationOutput
-
State that is passed back by provider
- getState() - Method in interface org.keycloak.models.UserSessionModel
- getStatus() - Method in class org.keycloak.keys.KeyMetadata
- getStatus() - Method in class org.keycloak.storage.user.SynchronizationResult
- getStorageProviders(Class<? extends Provider>) - Method in interface org.keycloak.models.RealmModel
-
Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.
- getStoredCredentialById(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Read a stored credential.
- getStoredCredentialById(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
- getStoredCredentialByNameAndType(String, String) - Method in interface org.keycloak.models.SubjectCredentialManager
- getStoredCredentialByNameAndType(RealmModel, UserModel, String, String) - Method in interface org.keycloak.credential.UserCredentialStore
- getStoredCredentialsByTypeStream(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Read stored credentials by type as a stream.
- getStoredCredentialsByTypeStream(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
-
Obtains the stored credentials associated with the specified user that match the specified type.
- getStoredCredentialsStream() - Method in interface org.keycloak.models.SubjectCredentialManager
-
Read stored credentials as a stream.
- getStoredCredentialsStream(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore
-
Obtains the stored credentials associated with the specified user.
- getStoredVersion() - Method in interface org.keycloak.migration.MigrationModel
- getStringSecret(String) - Method in interface org.keycloak.vault.VaultTranscriber
-
Obtains the secret represented as a
String
from the vault that matches the entry in the specified value. - getSubGroupsStream() - Method in interface org.keycloak.models.GroupModel
-
Returns all sub groups for the parent group as a stream.
- getSubType() - Method in class org.keycloak.component.ComponentModel
- getSubType() - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- getSupportedLocalesStream() - Method in interface org.keycloak.models.RealmModel
-
Returns supported locales as a stream.
- getSyncMode() - Method in class org.keycloak.models.IdentityProviderMapperModel
- getSyncMode() - Method in class org.keycloak.models.IdentityProviderModel
- getTabId() - Method in class org.keycloak.sessions.AuthenticationSessionCompoundId
- getTabId() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
- getTemplate(String) - Method in interface org.keycloak.theme.Theme
- getTemplate(String) - Method in interface org.keycloak.theme.ThemeResourceProvider
-
Load the template for the specific name
- getTheme(String, Theme.Type) - Method in interface org.keycloak.models.ThemeManager
-
Returns the specified theme for the specified type.
- getTheme(Theme.Type) - Method in interface org.keycloak.models.ThemeManager
-
Returns the theme for the specified type.
- getThemeName(Theme.Type) - Method in interface org.keycloak.theme.ThemeSelectorProvider
-
Return the theme name to use for the specified type
- getTimestamp() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getTimestamp() - Method in class org.keycloak.models.ClientInitialAccessModel
- getTimestamp() - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Returns timestamp when the root authentication session was created or updated.
- getToken() - Method in class org.keycloak.models.FederatedIdentityModel
- getTopLevelGroupsStream() - Method in interface org.keycloak.models.RealmModel
-
Returns top level groups as a stream.
- getTopLevelGroupsStream(Integer, Integer) - Method in interface org.keycloak.models.RealmModel
-
Returns top level groups as a stream.
- getTopLevelGroupsStream(RealmModel) - Method in interface org.keycloak.models.GroupProvider
-
Returns all top level groups (i.e.
- getTopLevelGroupsStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider
-
Returns top level groups (i.e.
- getTotalCodes() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- getTransactionManager() - Method in interface org.keycloak.models.KeycloakSession
- getTransports() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- getType() - Method in interface org.keycloak.credential.CredentialInput
- getType() - Method in class org.keycloak.credential.CredentialModel
- getType() - Method in interface org.keycloak.credential.CredentialProvider
- getType() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getType() - Method in class org.keycloak.models.ClaimTypeModel
- getType() - Method in class org.keycloak.models.OTPPolicy
- getType() - Method in class org.keycloak.models.RequiredCredentialModel
- getType() - Method in class org.keycloak.models.UserCredentialModel
- getType() - Method in class org.keycloak.provider.ProviderConfigProperty
-
Type of the variable.
- getType() - Method in interface org.keycloak.theme.Theme
- getTypeMetadata() - Method in interface org.keycloak.component.ComponentFactory
-
This is metadata about this component type.
- getTypeMetadata(RealmModel, ComponentModel) - Method in interface org.keycloak.component.SubComponentFactory
-
This is metadata about this component type.
- getUpdateAction() - Method in class org.keycloak.credential.CredentialTypeMetadata
- getUpdated() - Method in class org.keycloak.storage.user.SynchronizationResult
- getUpdatedClient() - Method in interface org.keycloak.models.ClientModel.ClientIdChangeEvent
- getUpdatedClient() - Method in interface org.keycloak.models.ClientModel.ClientUpdatedEvent
- getUpdatedIdentityProvider() - Method in interface org.keycloak.models.RealmModel.IdentityProviderUpdatedEvent
- getUri() - Method in interface org.keycloak.models.KeycloakContext
-
Returns the URI assuming it is a frontend request.
- getUri(UrlType) - Method in interface org.keycloak.models.KeycloakContext
-
Returns the URI.
- getUser() - Method in class org.keycloak.credential.CredentialTypeMetadataContext
- getUser() - Method in interface org.keycloak.models.UserModel.UserRemovedEvent
- getUser() - Method in interface org.keycloak.models.UserSessionModel
- getUserActionTokenLifespans() - Method in interface org.keycloak.models.RealmModel
-
This method will return a map with all the lifespans available or an empty map, but never null.
- getUserByCredential(RealmModel, CredentialInput) - Method in interface org.keycloak.storage.user.UserLookupProvider
- getUserByEmail(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider
-
Returns a user with the given email belonging to the realm
- getUserByFederatedIdentity(RealmModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
-
Returns a userModel that corresponds to the given socialLink.
- getUserById(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider
-
Returns a user with the given id belonging to the realm
- getUserByUsername(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider
-
Exact search for a user by its username.
- getUserId() - Method in class org.keycloak.models.DefaultActionTokenKey
- getUserId() - Method in class org.keycloak.models.FederatedIdentityModel
- getUserId() - Method in interface org.keycloak.models.SingleUseObjectKeyModel
- getUserId() - Method in interface org.keycloak.models.UserLoginFailureModel
- getUserLabel() - Method in class org.keycloak.credential.CredentialModel
- getUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserLoginFailureProvider
-
Returns the
UserLoginFailureModel
for the given realm and user id. - getUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
-
Deprecated.Use
getUserLoginFailure
instead. - getUsername() - Method in interface org.keycloak.models.UserModel
- getUsername() - Method in class org.keycloak.models.utils.UserModelDelegate
- getUsername() - Method in exception org.keycloak.policy.PasswordPolicyNotMetException
- getUserName() - Method in class org.keycloak.models.FederatedIdentityModel
- getUsersCount(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users, without consider any service account.
- getUsersCount(RealmModel, boolean) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users.
- getUsersCount(RealmModel, String) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users that would be returned by a call to
searchForUserStream
- getUsersCount(RealmModel, String, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users that would be returned by a call to
searchForUserStream
and are members of at least one of the groups given by thegroupIds
set. - getUsersCount(RealmModel, Map<String, String>) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users that match the given filter parameters.
- getUsersCount(RealmModel, Map<String, String>, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users that match the given filter parameters and is in at least one of the given groups.
- getUsersCount(RealmModel, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Returns the number of users that are in at least one of the groups given.
- getUserSession() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- getUserSession(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
- getUserSessionByBrokerSessionId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
- getUserSessionByBrokerUserIdStream(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the online user sessions associated with the user that matches the specified
brokerUserId
. - getUserSessionNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Retrieves value of given user session note.
- getUserSessionsStream(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the online user sessions associated with the specified client.
- getUserSessionsStream(RealmModel, ClientModel, Integer, Integer) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the online user sessions associated with the specified client, starting from the
firstResult
and containing at mostmaxResults
. - getUserSessionsStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Obtains the online user sessions associated with the specified user.
- getUserSessionWithPredicate(RealmModel, String, boolean, Predicate<UserSessionModel>) - Method in interface org.keycloak.models.UserSessionProvider
-
Return userSession of specified ID as long as the predicate passes.
- getUsersStream(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Deprecated.Use
UserQueryProvider.searchForUserStream(RealmModel, Map)
with an empty params map instead. - getUsersStream(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider
-
Deprecated.Use
UserQueryProvider.searchForUserStream(RealmModel, Map)
withUserModel.INCLUDE_SERVICE_ACCOUNT
within params instead. - getUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Deprecated.Use
UserQueryProvider.searchForUserStream(RealmModel, Map, Integer, Integer)
with an empty params map instead. - getUsersStream(RealmModel, Integer, Integer, boolean) - Method in interface org.keycloak.models.UserProvider
-
Deprecated.
- getUserVerificationRequirement() - Method in class org.keycloak.models.WebAuthnPolicy
- getValue() - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
- getValue() - Method in class org.keycloak.models.credential.dto.OTPSecretData
- getValue() - Method in class org.keycloak.models.credential.dto.PasswordSecretData
- getValue() - Method in class org.keycloak.models.UserCredentialModel
-
This method exists only because of the backwards compatibility.
- getWaitIncrementSeconds() - Method in interface org.keycloak.models.RealmModel
- getWarningMessageDescription() - Method in class org.keycloak.credential.CredentialMetadata
- getWarningMessageTitle() - Method in class org.keycloak.credential.CredentialMetadata
- getWebAuthnCredentialData() - Method in class org.keycloak.models.credential.WebAuthnCredentialModel
- getWebAuthnPolicy() - Method in interface org.keycloak.models.RealmModel
- getWebAuthnPolicyPasswordless() - Method in interface org.keycloak.models.RealmModel
- getWebAuthnSecretData() - Method in class org.keycloak.models.credential.WebAuthnCredentialModel
- getWebOrigins() - Method in interface org.keycloak.models.ClientModel
- grantRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
-
Grants the given role to this object.
- grantRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- grantToAllUsers(RealmModel, RoleModel) - Method in interface org.keycloak.storage.user.UserBulkUpdateProvider
-
Grants the given role to all users from particular realm.
- GROUP - org.keycloak.provider.InvalidationHandler.ObjectType
- GROUP_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- groupLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
- GroupLookupProvider - Interface in org.keycloak.storage.group
- GroupModel - Interface in org.keycloak.models
- GroupModel.GroupPathChangeEvent - Interface in org.keycloak.models
- GroupModel.GroupRemovedEvent - Interface in org.keycloak.models
- GroupModel.SearchableFields - Class in org.keycloak.models
- GroupModel.Streams - Interface in org.keycloak.models
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- GroupProvider - Interface in org.keycloak.models
-
Provider of group records
- groups() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed group provider instance.
- GROUPS - Static variable in interface org.keycloak.models.UserModel
- groupStorageManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- GUI_ORDER - Static variable in interface org.keycloak.models.ClientScopeModel
H
- hasDirectRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
-
Returns
true
, if this object is directly assigned the given role. - hasDirectScope(RoleModel) - Method in interface org.keycloak.models.ClientModel
- hasDirectScope(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
-
Returns
true
, if this object has the given role directly in its scope. - HASH_ALGORITHM_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy
- HASH_ALGORITHM_ID - Static variable in class org.keycloak.models.PasswordPolicy
- HASH_ITERATIONS_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy
- HASH_ITERATIONS_ID - Static variable in class org.keycloak.models.PasswordPolicy
- hashCode() - Method in class org.keycloak.models.AuthenticationExecutionModel
- hashCode() - Method in class org.keycloak.models.ClaimTypeModel
- hashCode() - Method in class org.keycloak.models.FederatedIdentityModel
- hashCode() - Method in class org.keycloak.models.IdentityProviderMapperModel
- hashCode() - Method in class org.keycloak.models.ProtocolMapperModel
- hashCode() - Method in class org.keycloak.models.utils.UserModelDelegate
- hashCode() - Method in class org.keycloak.rar.AuthorizationDetails
- hashCode() - Method in class org.keycloak.storage.StorageId
- hashRawCode(String) - Static method in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- hasNote(String) - Method in class org.keycloak.component.ComponentModel
- hasRole(Set<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils
- hasRole(Stream<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils
- hasRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel
-
Returns
true
if this object is directly or indirectly assigned the given role,false
otherwise. - hasRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
- hasRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- hasRoleFromGroup(Stream<GroupModel>, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils
-
Checks whether the
targetRole
is contained in any of thegroups
or their parents (if requested) - hasRoleFromGroup(GroupModel, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils
-
Checks whether the
targetRole
is contained in the given group or its parents (if requested) - hasScope(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel
-
Returns
true
, if this object has the given role directly or indirectly in its scope,false
otherwise. - helpText - Variable in class org.keycloak.provider.ProviderConfigProperty
- helpText(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- helpText(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
Help text that will be shown for this configuration property in the admin console when you hover over the tooltip
- HIDE_ON_LOGIN - Static variable in class org.keycloak.models.IdentityProviderModel
- HMAC_SHA1 - Static variable in class org.keycloak.models.utils.HmacOTP
- HMAC_SHA256 - Static variable in class org.keycloak.models.utils.HmacOTP
- HMAC_SHA512 - Static variable in class org.keycloak.models.utils.HmacOTP
- HmacOTP - Class in org.keycloak.models.utils
- HmacOTP(int, String, int) - Constructor for class org.keycloak.models.utils.HmacOTP
- HostnameProvider - Interface in org.keycloak.urls
-
The Hostname provider is used by Keycloak to decide URLs for frontend and backend requests.
- HostnameProviderFactory - Interface in org.keycloak.urls
- HostnameSpi - Class in org.keycloak.urls
- HostnameSpi() - Constructor for class org.keycloak.urls.HostnameSpi
- hotp(String) - Static method in class org.keycloak.models.UserCredentialModel
- HOTP - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- HOTP - Static variable in class org.keycloak.models.credential.OTPCredentialModel
- HOTP - Static variable in class org.keycloak.models.UserCredentialModel
-
Deprecated.
I
- iconCssClass(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- id - Variable in class org.keycloak.models.IdentityProviderMapperModel
- id - Variable in class org.keycloak.models.ProtocolMapperModel
- ID - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- ID - Static variable in class org.keycloak.models.ClientScopeModel.SearchableFields
- ID - Static variable in class org.keycloak.models.GroupModel.SearchableFields
- ID - Static variable in class org.keycloak.models.RealmModel.SearchableFields
- ID - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- ID - Static variable in class org.keycloak.models.SingleUseObjectValueModel.SearchableFields
- ID - Static variable in class org.keycloak.models.UserLoginFailureModel.SearchableFields
- ID - Static variable in class org.keycloak.models.UserModel.SearchableFields
- ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- ID - Static variable in class org.keycloak.sessions.RootAuthenticationSessionModel.SearchableFields
- identityProviderAlias - Variable in class org.keycloak.models.IdentityProviderMapperModel
- identityProviderMapper - Variable in class org.keycloak.models.IdentityProviderMapperModel
- IdentityProviderMapperModel - Class in org.keycloak.models
-
Specifies a mapping from broker login to user data.
- IdentityProviderMapperModel() - Constructor for class org.keycloak.models.IdentityProviderMapperModel
- IdentityProviderMapperSyncMode - Enum in org.keycloak.models
- IdentityProviderModel - Class in org.keycloak.models
-
A model type representing the configuration for identity providers.
- IdentityProviderModel() - Constructor for class org.keycloak.models.IdentityProviderModel
- IdentityProviderModel(IdentityProviderModel) - Constructor for class org.keycloak.models.IdentityProviderModel
- IdentityProviderSyncMode - Enum in org.keycloak.models
- IDP_ALIAS - Static variable in interface org.keycloak.models.UserModel
- IDP_AND_USER - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
This field can only searched either for users coming from an IDP, then the operand is (idp_alias), or as user coming from a particular IDP with given username there, then the operand is a pair (idp_alias, idp_user_id).
- IDP_USER_ID - Static variable in interface org.keycloak.models.UserModel
- ignored() - Static method in class org.keycloak.storage.user.SynchronizationResult
- IMPLICIT_HYBRID_TOKEN_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- IMPORT - org.keycloak.models.IdentityProviderMapperSyncMode
- IMPORT - org.keycloak.models.IdentityProviderSyncMode
- importComponentModel(ComponentModel) - Method in interface org.keycloak.models.RealmModel
-
Adds component model.
- importUserSessions(Collection<UserSessionModel>, boolean) - Method in interface org.keycloak.models.UserSessionProvider
-
Triggered by persister during pre-load.
- INCLUDE_IN_TOKEN_SCOPE - Static variable in interface org.keycloak.models.ClientScopeModel
- INCLUDE_SERVICE_ACCOUNT - Static variable in interface org.keycloak.models.UserModel
- increaseAdded() - Method in class org.keycloak.storage.user.SynchronizationResult
- increaseFailed() - Method in class org.keycloak.storage.user.SynchronizationResult
- increaseRemoved() - Method in class org.keycloak.storage.user.SynchronizationResult
- increaseUpdated() - Method in class org.keycloak.storage.user.SynchronizationResult
- incrementFailures() - Method in interface org.keycloak.models.UserLoginFailureModel
- INHERIT - org.keycloak.models.IdentityProviderMapperSyncMode
- init(Config.Scope) - Method in interface org.keycloak.provider.ProviderFactory
-
Only called once when the factory is first created.
- init(Config.Scope) - Method in interface org.keycloak.urls.HostnameProviderFactory
- initialCounter - Variable in class org.keycloak.models.OTPPolicy
- initLogoutToken(ClientModel, UserModel, AuthenticatedClientSessionModel) - Method in interface org.keycloak.models.TokenManager
- input - Variable in class org.keycloak.models.RequiredCredentialModel
- INSTANCE - Static variable in class org.keycloak.models.OrderedModel.OrderedModelComparator
- INT - org.keycloak.models.ClaimTypeModel.ValueType
- INT_CONFIG_TYPE - Static variable in interface org.keycloak.policy.PasswordPolicyProvider
- invalidate(KeycloakSession, InvalidationHandler.InvalidableObjectType, Object...) - Method in interface org.keycloak.provider.InvalidationHandler
-
Invalidates intermediate states of the given objects
- invalidate(InvalidationHandler.InvalidableObjectType, Object...) - Method in interface org.keycloak.models.KeycloakSession
-
Invalidates intermediate states of the given objects, both immediately and at the end of this session.
- InvalidationHandler - Interface in org.keycloak.provider
-
Handles invalidation requests.
- InvalidationHandler.InvalidableObjectType - Interface in org.keycloak.provider
-
Tagging interface for the kinds of invalidatable object
- InvalidationHandler.ObjectType - Enum in org.keycloak.provider
- IS_CLIENT_ROLE - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- IS_DYNAMIC_SCOPE - Static variable in interface org.keycloak.models.ClientScopeModel
- IS_OFFLINE - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- isActive() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- isActive() - Method in interface org.keycloak.models.KeycloakTransaction
- isAddReadTokenRoleOnCreate() - Method in class org.keycloak.models.IdentityProviderModel
- isAdminEventsDetailsEnabled() - Method in interface org.keycloak.models.RealmModel
- isAdminEventsEnabled() - Method in interface org.keycloak.models.RealmModel
- isAdminRequest() - Method in class org.keycloak.models.UserCredentialModel
- isAlternative() - Method in class org.keycloak.models.AuthenticationExecutionModel
- isAlwaysDisplayInConsole() - Method in interface org.keycloak.models.ClientModel
- isAuthenticateByDefault() - Method in class org.keycloak.models.IdentityProviderModel
-
Deprecated.
- isAuthenticatorFlow() - Method in class org.keycloak.models.AuthenticationExecutionModel
-
Is the referenced authenticator a flow?
- isAvoidSameAuthenticatorRegister() - Method in class org.keycloak.models.WebAuthnPolicy
- isBearerOnly() - Method in interface org.keycloak.models.ClientModel
- isBlank(String) - Static method in class org.keycloak.utils.StringUtil
- isBruteForceProtected() - Method in interface org.keycloak.models.RealmModel
- isBuiltIn() - Method in class org.keycloak.models.AuthenticationFlowModel
- isBuiltIn() - Method in class org.keycloak.models.ClaimTypeModel
- isCacheEnabled() - Method in interface org.keycloak.models.ThemeManager
- isClientRole() - Method in interface org.keycloak.models.RoleModel
- isClientRole(RoleModel, ClientModel) - Static method in class org.keycloak.models.utils.RoleUtils
- isClientScopeGranted(ClientScopeModel) - Method in class org.keycloak.models.UserConsentModel
- isCodeReusable - Variable in class org.keycloak.models.OTPPolicy
- isCodeReusable() - Method in class org.keycloak.models.OTPPolicy
- isComposite() - Method in interface org.keycloak.models.RoleModel
- isConditional() - Method in class org.keycloak.models.AuthenticationExecutionModel
- isConfiguredFor(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Check if the credential type is configured for this entity.
- isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputValidator
- isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Checks to see if user has credential type configured.
- isConfiguredLocally(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Deprecated.
- isConfiguredLocally(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Only loops through each CredentialProvider to see if credential type is configured for the user.
- isConsentRequired() - Method in interface org.keycloak.models.ClientModel
- isDefaultAction() - Method in class org.keycloak.models.RequiredActionProviderModel
- isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientModel
- isDirectMember(Stream<GroupModel>, GroupModel) - Static method in class org.keycloak.models.utils.RoleUtils
- isDisabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
- isDisplayOnConsentScreen() - Method in interface org.keycloak.models.ClientModel
- isDisplayOnConsentScreen() - Method in interface org.keycloak.models.ClientScopeModel
- isDuplicateEmailsAllowed() - Method in interface org.keycloak.models.RealmModel
- isDynamicScope() - Method in interface org.keycloak.models.ClientScopeModel
- isDynamicScope() - Method in class org.keycloak.rar.AuthorizationDetails
-
Returns whether the current
AuthorizationDetails
object is a dynamic scope - isEditUsernameAllowed() - Method in interface org.keycloak.models.RealmModel
- isEmailVerified() - Method in interface org.keycloak.models.UserModel
- isEmailVerified() - Method in class org.keycloak.models.utils.UserModelDelegate
- isEnabled() - Method in class org.keycloak.models.AuthenticationExecutionModel
- isEnabled() - Method in interface org.keycloak.models.ClientModel
- isEnabled() - Method in class org.keycloak.models.IdentityProviderModel
- isEnabled() - Method in interface org.keycloak.models.RealmModel
- isEnabled() - Method in class org.keycloak.models.RequiredActionProviderModel
- isEnabled() - Method in interface org.keycloak.models.UserModel
- isEnabled() - Method in class org.keycloak.models.utils.UserModelDelegate
- isEnabled() - Method in interface org.keycloak.provider.Spi
- isEventsEnabled() - Method in interface org.keycloak.models.RealmModel
- isFrontchannelLogout() - Method in interface org.keycloak.models.ClientModel
- isFullScopeAllowed() - Method in interface org.keycloak.models.ClientModel
- isHideOnLogin() - Method in class org.keycloak.models.IdentityProviderModel
- isIdentityFederationEnabled() - Method in interface org.keycloak.models.RealmModel
- isIgnored() - Method in class org.keycloak.storage.user.SynchronizationResult
- isImplicitFlowEnabled() - Method in interface org.keycloak.models.ClientModel
- isIncludeInTokenScope() - Method in interface org.keycloak.models.ClientScopeModel
- isInput() - Method in class org.keycloak.models.RequiredCredentialModel
- isInternal() - Method in class org.keycloak.locale.LocaleSelectorSPI
- isInternal() - Method in class org.keycloak.locale.LocaleUpdaterSPI
- isInternal() - Method in interface org.keycloak.provider.Spi
- isInternal() - Method in class org.keycloak.theme.ThemeResourceSpi
- isInternal() - Method in class org.keycloak.theme.ThemeSelectorSpi
- isInternal() - Method in class org.keycloak.urls.HostnameSpi
- isInternal() - Method in class org.keycloak.vault.VaultSpi
- isInternationalizationEnabled() - Method in interface org.keycloak.models.RealmModel
- isLinkOnly() - Method in class org.keycloak.models.IdentityProviderModel
- isLocal() - Method in class org.keycloak.storage.StorageId
- isLocalStorage(String) - Static method in class org.keycloak.storage.StorageId
- isLocalStorage(ClientModel) - Static method in class org.keycloak.storage.StorageId
-
Deprecated.Use
StorageId.isLocalStorage(String)
instead. - isLocalStorage(UserModel) - Static method in class org.keycloak.storage.StorageId
-
Deprecated.Use
StorageId.isLocalStorage(String)
instead. - isLoginHint() - Method in class org.keycloak.models.IdentityProviderModel
- isLoginWithEmailAllowed() - Method in interface org.keycloak.models.RealmModel
- isMember(Stream<GroupModel>, GroupModel) - Static method in class org.keycloak.models.utils.RoleUtils
- isMemberOf(GroupModel) - Method in interface org.keycloak.models.UserModel
- isMemberOf(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- isNotBlank(String) - Static method in class org.keycloak.utils.StringUtil
- isOAuth2DeviceAuthorizationGrantEnabled(ClientModel) - Method in class org.keycloak.models.OAuth2DeviceConfig
- isOffline() - Method in interface org.keycloak.models.UserSessionModel
- isOfflineSessionMaxLifespanEnabled() - Method in interface org.keycloak.models.RealmModel
- isOIDCCIBAGrantEnabled(ClientModel) - Method in class org.keycloak.models.CibaConfig
- isOtp(String) - Static method in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- isPassMaxAge() - Method in class org.keycloak.models.IdentityProviderModel
- isPermanentLockout() - Method in interface org.keycloak.models.RealmModel
- isPublicClient() - Method in interface org.keycloak.models.ClientModel
- isReadOnly() - Method in class org.keycloak.provider.ProviderConfigProperty
- isRealmRole(RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils
- isRealmRole(RoleModel, RealmModel) - Static method in class org.keycloak.models.utils.RoleUtils
- isRegistrationAllowed() - Method in interface org.keycloak.models.RealmModel
- isRegistrationEmailAsUsername() - Method in interface org.keycloak.models.RealmModel
- isRememberMe() - Method in interface org.keycloak.models.RealmModel
- isRememberMe() - Method in interface org.keycloak.models.UserSessionModel
- isRemoveable() - Method in class org.keycloak.credential.CredentialTypeMetadata
- isRequired() - Method in class org.keycloak.models.AuthenticationExecutionModel
- isRequirePushedAuthorizationRequests(ClientModel) - Method in class org.keycloak.models.ParConfig
- isResetPasswordAllowed() - Method in interface org.keycloak.models.RealmModel
- isRevokeRefreshToken() - Method in interface org.keycloak.models.RealmModel
- isSecret() - Method in class org.keycloak.models.RequiredCredentialModel
- isSecret() - Method in class org.keycloak.provider.ProviderConfigProperty
-
If true, this variable is only writeable.
- isServiceAccountsEnabled() - Method in interface org.keycloak.models.ClientModel
- isStandardFlowEnabled() - Method in interface org.keycloak.models.ClientModel
- isStoreToken() - Method in class org.keycloak.models.IdentityProviderModel
- isSurrogateAuthRequired() - Method in interface org.keycloak.models.ClientModel
- isTopLevel() - Method in class org.keycloak.models.AuthenticationFlowModel
- isTrustEmail() - Method in class org.keycloak.models.IdentityProviderModel
- isUserManagedAccessAllowed() - Method in interface org.keycloak.models.RealmModel
- isValid(List<CredentialInput>) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Validate a list of credentials.
- isValid(CredentialInput...) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Validate a list of credentials.
- isValid(RealmModel, UserModel, List<CredentialInput>) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Validates list of credentials.
- isValid(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputValidator
-
Tests whether a credential is valid
- isValid(RealmModel, UserModel, CredentialInput...) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Validates list of credentials.
- isVerifyEmail() - Method in interface org.keycloak.models.RealmModel
J
- joinGroup(GroupModel) - Method in interface org.keycloak.models.UserModel
- joinGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- JSON - org.keycloak.models.ClaimTypeModel.ValueType
- JSON_FIELD_ACTION_VERIFICATION_NONCE - Static variable in class org.keycloak.models.DefaultActionTokenKey
- JsonConfigComponentModel - Class in org.keycloak.component
-
Component model backed by JSON configuration.
- JsonConfigComponentModel(Class<? extends Provider>, String, String, JsonNode) - Constructor for class org.keycloak.component.JsonConfigComponentModel
K
- KC_LOCALE_PARAM - Static variable in interface org.keycloak.locale.LocaleSelectorProvider
- kerberos(String) - Static method in class org.keycloak.models.UserCredentialModel
- KERBEROS - Static variable in class org.keycloak.credential.CredentialModel
- KERBEROS - Static variable in class org.keycloak.models.RequiredCredentialModel
- KERBEROS - Static variable in class org.keycloak.models.UserCredentialModel
- KeycloakContext - Interface in org.keycloak.models
- keycloakId(ComponentModel, String) - Static method in class org.keycloak.storage.StorageId
-
generate the id string that should be returned by UserModel.getId()
- KeycloakSession - Interface in org.keycloak.models
- KeycloakSessionFactory - Interface in org.keycloak.models
- KeycloakSessionTask - Interface in org.keycloak.models
-
Task to be executed inside transaction
- KeycloakSessionTaskWithResult<V> - Interface in org.keycloak.models
-
Interface for tasks that compute a result and need access to the
KeycloakSession
. - KeycloakTransaction - Interface in org.keycloak.models
- KeycloakTransactionManager - Interface in org.keycloak.models
- KeycloakTransactionManager.JTAPolicy - Enum in org.keycloak.models
- KeycloakUriInfo - Class in org.keycloak.models
- KeycloakUriInfo(KeycloakSession, UrlType, UriInfo) - Constructor for class org.keycloak.models.KeycloakUriInfo
- KeyManager - Interface in org.keycloak.models
- KeyManager.ActiveAesKey - Class in org.keycloak.models
- KeyManager.ActiveHmacKey - Class in org.keycloak.models
- KeyManager.ActiveRsaKey - Class in org.keycloak.models
- KeyMetadata - Class in org.keycloak.keys
- KeyMetadata() - Constructor for class org.keycloak.keys.KeyMetadata
- keys() - Method in interface org.keycloak.models.KeycloakSession
-
Key manager
L
- label - Variable in class org.keycloak.provider.ProviderConfigProperty
- label(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
Label that will be shown for this configuration property in the admin console
- LAST_NAME - Static variable in interface org.keycloak.models.UserModel
- LAST_NAME - Static variable in class org.keycloak.models.UserModel.SearchableFields
- LAST_SESSION_REFRESH - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- leaveGroup(GroupModel) - Method in interface org.keycloak.models.UserModel
- leaveGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate
- LEGACY - org.keycloak.models.IdentityProviderMapperSyncMode
- LEGACY - org.keycloak.models.IdentityProviderSyncMode
- linkOnly - Variable in class org.keycloak.models.IdentityProviderModel
- LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
-
Possibility to configure single String value, which needs to be chosen from the list of predefined values (HTML select)
- listClientInitialAccessStream(RealmModel) - Method in interface org.keycloak.models.RealmProvider
-
Returns client's initial access as a stream.
- listProviderIds(Class<T>) - Method in interface org.keycloak.models.KeycloakSession
-
Get all provider factories that manage provider instances of class.
- LOCALE - Static variable in interface org.keycloak.models.UserModel
- LOCALE_COOKIE - Static variable in interface org.keycloak.locale.LocaleSelectorProvider
- LocaleSelectorProvider - Interface in org.keycloak.locale
- LocaleSelectorProviderFactory - Interface in org.keycloak.locale
- LocaleSelectorSPI - Class in org.keycloak.locale
- LocaleSelectorSPI() - Constructor for class org.keycloak.locale.LocaleSelectorSPI
- LocaleUpdaterProvider - Interface in org.keycloak.locale
- LocaleUpdaterProviderFactory - Interface in org.keycloak.locale
- LocaleUpdaterSPI - Class in org.keycloak.locale
- LocaleUpdaterSPI() - Constructor for class org.keycloak.locale.LocaleUpdaterSPI
- LocalizedMessage(String, Object[]) - Constructor for class org.keycloak.credential.CredentialMetadata.LocalizedMessage
- LOGGED_IN - org.keycloak.models.UserSessionModel.State
- LOGGED_OUT - org.keycloak.models.UserSessionModel.State
- LOGGED_OUT - org.keycloak.sessions.CommonClientSessionModel.Action
- LOGGED_OUT_UNCONFIRMED - org.keycloak.models.UserSessionModel.State
- logger - Static variable in class org.keycloak.models.AbstractKeycloakTransaction
- logger - Static variable in class org.keycloak.models.credential.dto.PasswordSecretData
- logger - Static variable in class org.keycloak.models.OTPPolicy
- logger - Static variable in class org.keycloak.models.WebAuthnPolicy
- LOGGING_OUT - org.keycloak.models.UserSessionModel.State
- LOGGING_OUT - org.keycloak.sessions.CommonClientSessionModel.Action
- LOGIN - org.keycloak.theme.Theme.Type
- LOGIN_HINT - Static variable in class org.keycloak.models.IdentityProviderModel
- loginFailures() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- LOGO_URI - Static variable in interface org.keycloak.models.ClientModel
- LOGOUT_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- lookAheadWindow - Variable in class org.keycloak.models.OTPPolicy
- lookAheadWindow - Variable in class org.keycloak.models.utils.HmacOTP
M
- MAP_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
-
Configure multiple (key, value) pairs
- merge(CredentialValidationOutput) - Method in class org.keycloak.models.CredentialValidationOutput
- MigrationModel - Interface in org.keycloak.migration
- ModelDuplicateException - Exception in org.keycloak.models
- ModelDuplicateException() - Constructor for exception org.keycloak.models.ModelDuplicateException
- ModelDuplicateException(String) - Constructor for exception org.keycloak.models.ModelDuplicateException
- ModelDuplicateException(String, String) - Constructor for exception org.keycloak.models.ModelDuplicateException
- ModelDuplicateException(String, Throwable) - Constructor for exception org.keycloak.models.ModelDuplicateException
- ModelDuplicateException(Throwable) - Constructor for exception org.keycloak.models.ModelDuplicateException
- ModelException - Exception in org.keycloak.models
- ModelException() - Constructor for exception org.keycloak.models.ModelException
- ModelException(String) - Constructor for exception org.keycloak.models.ModelException
- ModelException(String, Object...) - Constructor for exception org.keycloak.models.ModelException
- ModelException(String, Throwable) - Constructor for exception org.keycloak.models.ModelException
- ModelException(Throwable) - Constructor for exception org.keycloak.models.ModelException
- ModelIllegalStateException - Exception in org.keycloak.models
-
Thrown when data can't be retrieved for the model.
- ModelIllegalStateException() - Constructor for exception org.keycloak.models.ModelIllegalStateException
- ModelIllegalStateException(String) - Constructor for exception org.keycloak.models.ModelIllegalStateException
- ModelIllegalStateException(String, Throwable) - Constructor for exception org.keycloak.models.ModelIllegalStateException
- ModelIllegalStateException(Throwable) - Constructor for exception org.keycloak.models.ModelIllegalStateException
- moveCredentialTo(RealmModel, UserModel, String, String) - Method in interface org.keycloak.credential.UserCredentialStore
- moveGroup(GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmModel
- moveGroup(RealmModel, GroupModel, GroupModel) - Method in interface org.keycloak.models.GroupProvider
-
This method is used for moving groups in group structure, for example: making an existing child group child group of some other group, setting a top level group (i.e.
- moveGroup(RealmModel, GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - moveStoredCredentialTo(String, String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Re-order the stored credentials.
- MULTIVALUED_LIST_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
-
Possibility to configure multiple String values, which needs to be chosen from the list of predefined values (HTML select with multiple)
- MULTIVALUED_STRING_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
-
Possibility to configure multiple String values of any value (something like "redirect_uris" for clients)
N
- name - Variable in class org.keycloak.models.IdentityProviderMapperModel
- name - Variable in class org.keycloak.models.ProtocolMapperModel
- name - Variable in class org.keycloak.provider.ProviderConfigProperty
- name(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
- NAME - Static variable in class org.keycloak.models.ClientScopeModel.SearchableFields
- NAME - Static variable in class org.keycloak.models.GroupModel.SearchableFields
- NAME - Static variable in class org.keycloak.models.RealmModel.SearchableFields
- NAME - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- nameSet(Theme.Type) - Method in interface org.keycloak.models.ThemeManager
-
Returns a set of all theme names for the specified type.
- NOM_ALGORITHM_TO_HASH - Static variable in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- NOT_STARTED - org.keycloak.models.AbstractKeycloakTransaction.TransactionState
- NOT_SUPPORTED - org.keycloak.models.KeycloakTransactionManager.JTAPolicy
-
Do not interact with JTA at all
- notes - Variable in class org.keycloak.models.UserCredentialModel
- NUM_HASH_ITERATIONS - Static variable in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- numberDigits - Variable in class org.keycloak.models.utils.HmacOTP
O
- OAUTH_GRANT - org.keycloak.sessions.CommonClientSessionModel.Action
- OAUTH2_DEVICE_AUTHORIZATION_GRANT_ENABLED - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- OAUTH2_DEVICE_CODE_LIFESPAN - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- OAUTH2_DEVICE_CODE_LIFESPAN_PER_CLIENT - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- OAUTH2_DEVICE_POLLING_INTERVAL - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- OAUTH2_DEVICE_POLLING_INTERVAL_PER_CLIENT - Static variable in class org.keycloak.models.OAuth2DeviceConfig
- OAuth2DeviceConfig - Class in org.keycloak.models
- OAuth2DeviceConfig(RealmModel) - Constructor for class org.keycloak.models.OAuth2DeviceConfig
- OBJECT_KEY - Static variable in class org.keycloak.models.SingleUseObjectValueModel.SearchableFields
- obtainSecret(String) - Method in interface org.keycloak.vault.VaultProvider
-
Retrieves a secret from vault.
- OIDC_CIBA_GRANT_ENABLED - Static variable in class org.keycloak.models.CibaConfig
- onClientRemoved(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider
- onClientRemoved(RealmModel, ClientModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Removes all associated root authentication sessions to the given realm and client which was removed.
- onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
-
Called after a component is created
- onEvent(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventListener
- onRealmRemoved(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
- onRealmRemoved(RealmModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Removes all associated root authentication sessions to the given realm which was removed.
- onUpdate(KeycloakSession, RealmModel, ComponentModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
-
Called after the component is updated.
- options - Variable in class org.keycloak.provider.ProviderConfigProperty
- options(String...) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
If configuring a list type, these are the options you can choose from.
- options(List<String>) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
If configuring a list type, these are the options you can choose from.
- order() - Method in interface org.keycloak.provider.ProviderFactory
- OrderedModel - Interface in org.keycloak.models
- OrderedModel.OrderedModelComparator<OM extends OrderedModel> - Class in org.keycloak.models
- OrderedModelComparator() - Constructor for class org.keycloak.models.OrderedModel.OrderedModelComparator
- org.keycloak.component - package org.keycloak.component
- org.keycloak.credential - package org.keycloak.credential
- org.keycloak.credential.hash - package org.keycloak.credential.hash
- org.keycloak.keys - package org.keycloak.keys
- org.keycloak.locale - package org.keycloak.locale
- org.keycloak.migration - package org.keycloak.migration
- org.keycloak.models - package org.keycloak.models
- org.keycloak.models.credential - package org.keycloak.models.credential
- org.keycloak.models.credential.dto - package org.keycloak.models.credential.dto
- org.keycloak.models.utils - package org.keycloak.models.utils
- org.keycloak.policy - package org.keycloak.policy
- org.keycloak.provider - package org.keycloak.provider
- org.keycloak.rar - package org.keycloak.rar
- org.keycloak.services.clientpolicy - package org.keycloak.services.clientpolicy
- org.keycloak.sessions - package org.keycloak.sessions
- org.keycloak.storage - package org.keycloak.storage
- org.keycloak.storage.client - package org.keycloak.storage.client
- org.keycloak.storage.clientscope - package org.keycloak.storage.clientscope
- org.keycloak.storage.group - package org.keycloak.storage.group
- org.keycloak.storage.role - package org.keycloak.storage.role
- org.keycloak.storage.user - package org.keycloak.storage.user
- org.keycloak.theme - package org.keycloak.theme
- org.keycloak.urls - package org.keycloak.urls
- org.keycloak.utils - package org.keycloak.utils
- org.keycloak.vault - package org.keycloak.vault
- otp(String, String) - Static method in class org.keycloak.models.UserCredentialModel
- OTP - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- OTPCredentialData - Class in org.keycloak.models.credential.dto
- OTPCredentialData(String, int, int, int, String) - Constructor for class org.keycloak.models.credential.dto.OTPCredentialData
- OTPCredentialModel - Class in org.keycloak.models.credential
- OTPPolicy - Class in org.keycloak.models
- OTPPolicy() - Constructor for class org.keycloak.models.OTPPolicy
- OTPPolicy(String, String, int, int, int, int) - Constructor for class org.keycloak.models.OTPPolicy
- OTPPolicy(String, String, int, int, int, int, boolean) - Constructor for class org.keycloak.models.OTPPolicy
- OTPSecretData - Class in org.keycloak.models.credential.dto
- OTPSecretData(String) - Constructor for class org.keycloak.models.credential.dto.OTPSecretData
P
- PAR_REQUEST_URI_LIFESPAN - Static variable in class org.keycloak.models.ParConfig
- ParConfig - Class in org.keycloak.models
- ParConfig(RealmModel) - Constructor for class org.keycloak.models.ParConfig
- PARENT_ID - Static variable in class org.keycloak.models.GroupModel.SearchableFields
-
Parent group ID
- parse(KeycloakSession, String) - Static method in class org.keycloak.models.PasswordPolicy
- parseConfig(String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
- parseInteger(String, Integer) - Method in interface org.keycloak.policy.PasswordPolicyProvider
- parsePriority(ComponentModel) - Static method in class org.keycloak.component.PrioritizedComponentModel
- PASS_MAX_AGE - Static variable in class org.keycloak.models.IdentityProviderModel
- password(String) - Static method in class org.keycloak.models.UserCredentialModel
- password(String, boolean) - Static method in class org.keycloak.models.UserCredentialModel
- PASSWORD - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- PASSWORD - Static variable in class org.keycloak.models.RequiredCredentialModel
- PASSWORD - Static variable in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- PASSWORD - Static variable in class org.keycloak.provider.ProviderConfigProperty
- PASSWORD_HISTORY - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- PASSWORD_HISTORY - Static variable in class org.keycloak.models.credential.PasswordCredentialModel
- PASSWORD_HISTORY - Static variable in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- PASSWORD_HISTORY_ID - Static variable in class org.keycloak.models.PasswordPolicy
- PASSWORD_TOKEN - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- PASSWORD_TOKEN - Static variable in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- PasswordCredentialData - Class in org.keycloak.models.credential.dto
- PasswordCredentialData(int, String) - Constructor for class org.keycloak.models.credential.dto.PasswordCredentialData
-
Creator for standard algorithms (no algorithm tuning beyond hash iterations)
- PasswordCredentialData(int, String, Map<String, List<String>>) - Constructor for class org.keycloak.models.credential.dto.PasswordCredentialData
-
Creator for custom algorithms (algorithm with tuning parameters beyond simple has iterations)
- PasswordCredentialModel - Class in org.keycloak.models.credential
- PasswordHashProvider - Interface in org.keycloak.credential.hash
- PASSWORDLESS - org.keycloak.credential.CredentialTypeMetadata.Category
- PasswordPolicy - Class in org.keycloak.models
- PasswordPolicy.Builder - Class in org.keycloak.models
- PasswordPolicyConfigException - Exception in org.keycloak.policy
-
Created by st on 23/05/17.
- PasswordPolicyConfigException(String) - Constructor for exception org.keycloak.policy.PasswordPolicyConfigException
- PasswordPolicyNotMetException - Exception in org.keycloak.policy
- PasswordPolicyNotMetException() - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyNotMetException(String) - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyNotMetException(String, String) - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyNotMetException(String, String, Throwable) - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyNotMetException(String, Throwable) - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyNotMetException(Throwable) - Constructor for exception org.keycloak.policy.PasswordPolicyNotMetException
- PasswordPolicyProvider - Interface in org.keycloak.policy
- PasswordSecretData - Class in org.keycloak.models.credential.dto
- PasswordSecretData(String, byte[]) - Constructor for class org.keycloak.models.credential.dto.PasswordSecretData
-
Default creator (Secret consists only of a value and a single salt)
- PasswordSecretData(String, String, Map<String, List<String>>) - Constructor for class org.keycloak.models.credential.dto.PasswordSecretData
-
Creator with the option to provide customized secret data (multiple salt values, chiefly)
- passwordToken(String) - Static method in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- PasswordUserCredentialModel - Class in org.keycloak.models.credential
-
Deprecated.Recommended to use
UserCredentialModel
as it contains all the functionality required by this class - PasswordUserCredentialModel(String, String, String, boolean) - Constructor for class org.keycloak.models.credential.PasswordUserCredentialModel
-
Deprecated.
- period - Variable in class org.keycloak.models.OTPPolicy
- PERSISTENT - org.keycloak.models.UserSessionModel.SessionPersistenceState
-
Session will be marked as persistent when created and it will be saved into the persistent storage (EG.
- persistRealmAttribute(String, Integer) - Method in class org.keycloak.models.AbstractConfig
- persistRealmAttribute(String, String) - Method in class org.keycloak.models.AbstractConfig
- POLICY_URI - Static variable in interface org.keycloak.models.ClientModel
- policyCheck(PasswordPolicy, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
-
Deprecated.Exists due the backwards compatibility. It is recommended to use
PasswordHashProvider.policyCheck(PasswordPolicy, PasswordCredentialModel)
- policyCheck(PasswordPolicy, PasswordCredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
- PolicyError - Class in org.keycloak.policy
- PolicyError(String, Object...) - Constructor for class org.keycloak.policy.PolicyError
- postInit(KeycloakSessionFactory) - Method in interface org.keycloak.provider.ProviderFactory
-
Called after all provider factories have been initialized
- postInit(KeycloakSessionFactory) - Method in interface org.keycloak.urls.HostnameProviderFactory
- preRemove(ClientScopeModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a client scope is removed.
- preRemove(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
-
Called before the component is removed.
- preRemove(ProtocolMapperModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a protocolMapper is removed
- preRemove(RealmModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a realm is removed.
- preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a component is removed.
- preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a client is removed.
- preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a group is removed.
- preRemove(RealmModel, IdentityProviderModel) - Method in interface org.keycloak.models.UserProvider
-
Called when an identity provider is removed.
- preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.models.UserProvider
-
Called when a role is removed.
- PrioritizedComponentModel - Class in org.keycloak.component
- PrioritizedComponentModel() - Constructor for class org.keycloak.component.PrioritizedComponentModel
- PrioritizedComponentModel(ComponentModel) - Constructor for class org.keycloak.component.PrioritizedComponentModel
- PRIORITY - Static variable in class org.keycloak.component.PrioritizedComponentModel
- PRIVATE_KEY - Static variable in interface org.keycloak.models.ClientModel
- property() - Method in class org.keycloak.provider.ProviderConfigurationBuilder
- property(String, String, String, String, Object, List<String>) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
- property(String, String, String, String, Object, List<String>, boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
- property(ProviderConfigProperty) - Method in class org.keycloak.provider.ProviderConfigurationBuilder
- protocol - Variable in class org.keycloak.models.ProtocolMapperModel
- protocolMapper - Variable in class org.keycloak.models.ProtocolMapperModel
- ProtocolMapperContainerModel - Interface in org.keycloak.models
- ProtocolMapperModel - Class in org.keycloak.models
-
Specifies a mapping from user data to a protocol claim assertion.
- ProtocolMapperModel() - Constructor for class org.keycloak.models.ProtocolMapperModel
- Provider - Interface in org.keycloak.provider
- PROVIDER_FACTORY - org.keycloak.provider.InvalidationHandler.ObjectType
- ProviderConfigProperty - Class in org.keycloak.provider
-
Configuration property metadata.
- ProviderConfigProperty() - Constructor for class org.keycloak.provider.ProviderConfigProperty
- ProviderConfigProperty(String, String, String, String, Object) - Constructor for class org.keycloak.provider.ProviderConfigProperty
- ProviderConfigProperty(String, String, String, String, Object, boolean) - Constructor for class org.keycloak.provider.ProviderConfigProperty
- ProviderConfigProperty(String, String, String, String, Object, String...) - Constructor for class org.keycloak.provider.ProviderConfigProperty
- ProviderConfigPropertyBuilder() - Constructor for class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
- ProviderConfigurationBuilder - Class in org.keycloak.provider
-
Builds a list of ProviderConfigProperty instances.
- ProviderConfigurationBuilder.ProviderConfigPropertyBuilder - Class in org.keycloak.provider
- ProviderEvent - Interface in org.keycloak.provider
- ProviderEventListener - Interface in org.keycloak.provider
- ProviderEventManager - Interface in org.keycloak.provider
- ProviderFactory<T extends Provider> - Interface in org.keycloak.provider
-
At boot time, keycloak discovers all factories.
- providerId(String) - Static method in class org.keycloak.storage.StorageId
- PUBLIC_KEY - Static variable in interface org.keycloak.models.ClientModel
- publish(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventManager
- PUSHED_AUTHORIZATION_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- put(String, boolean) - Method in class org.keycloak.component.ComponentModel
- put(String, int) - Method in class org.keycloak.component.ComponentModel
- put(String, long) - Method in class org.keycloak.component.ComponentModel
- put(String, String) - Method in class org.keycloak.component.ComponentModel
- put(String, String) - Method in class org.keycloak.models.PasswordPolicy.Builder
R
- ReadOnlyException - Exception in org.keycloak.storage
-
Thrown when UserStorageProvider UserModel adapter is read-only
- ReadOnlyException() - Constructor for exception org.keycloak.storage.ReadOnlyException
- ReadOnlyException(String) - Constructor for exception org.keycloak.storage.ReadOnlyException
- realm - Variable in class org.keycloak.models.AbstractConfig
- REALM - org.keycloak.provider.InvalidationHandler.ObjectType
- REALM_ID - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.ClientScopeModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.GroupModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.RoleModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.UserLoginFailureModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.UserModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- REALM_ID - Static variable in class org.keycloak.sessions.RootAuthenticationSessionModel.SearchableFields
- REALM_REUSABLE_CODE_ATTRIBUTE - Static variable in class org.keycloak.models.OTPPolicy
- realmForWrite - Variable in class org.keycloak.models.AbstractConfig
- realmLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- RealmModel - Interface in org.keycloak.models
- RealmModel.IdentityProviderRemovedEvent - Interface in org.keycloak.models
- RealmModel.IdentityProviderUpdatedEvent - Interface in org.keycloak.models
- RealmModel.RealmCreationEvent - Interface in org.keycloak.models
- RealmModel.RealmPostCreateEvent - Interface in org.keycloak.models
- RealmModel.RealmRemovedEvent - Interface in org.keycloak.models
- RealmModel.SearchableFields - Class in org.keycloak.models
- RealmProvider - Interface in org.keycloak.models
- realms() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- RECOVERY_AUTHN_CODES_INPUT_DEFAULT_ERROR_MESSAGE - Static variable in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- RECOVERY_CODES_GENERATE_NEW_CODES - Static variable in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- RECOVERY_CODES_NUMBER_REMAINING - Static variable in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- RECOVERY_CODES_NUMBER_USED - Static variable in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy
- RECOVERY_CODES_WARNING_THRESHOLD_ID - Static variable in class org.keycloak.models.PasswordPolicy
- RecoveryAuthnCodeRepresentation - Class in org.keycloak.models.credential.dto
- RecoveryAuthnCodeRepresentation(int, String) - Constructor for class org.keycloak.models.credential.dto.RecoveryAuthnCodeRepresentation
- RecoveryAuthnCodesCredentialData - Class in org.keycloak.models.credential.dto
- RecoveryAuthnCodesCredentialData(int, String, int, int) - Constructor for class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- RecoveryAuthnCodesCredentialModel - Class in org.keycloak.models.credential
- RecoveryAuthnCodesSecretData - Class in org.keycloak.models.credential.dto
- RecoveryAuthnCodesSecretData(List<RecoveryAuthnCodeRepresentation>) - Constructor for class org.keycloak.models.credential.dto.RecoveryAuthnCodesSecretData
- RecoveryAuthnCodesUtils - Class in org.keycloak.models.utils
- RecoveryAuthnCodesUtils() - Constructor for class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- register(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
- REGISTER - org.keycloak.services.clientpolicy.ClientPolicyEvent
- REGISTERED - org.keycloak.services.clientpolicy.ClientPolicyEvent
- registerNode(String, int) - Method in interface org.keycloak.models.ClientModel
-
Register node or just update the 'lastReRegistration' time if this node is already registered
- relativize(URI) - Method in class org.keycloak.models.KeycloakUriInfo
- remove(String) - Method in class org.keycloak.models.PasswordPolicy.Builder
- removeable(boolean) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- removeAllExpired() - Method in interface org.keycloak.models.UserSessionProvider
-
Remove expired user sessions and client sessions in all the realms
- removeAllExpired() - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Deprecated.manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entities
- removeAllUserLoginFailures(RealmModel) - Method in interface org.keycloak.models.UserLoginFailureProvider
-
Removes all the
UserLoginFailureModel
for the given realm. - removeAllUserLoginFailures(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Deprecated.Use
removeAllUserLoginFailures
instead. - removeAttribute(String) - Method in interface org.keycloak.models.ClientModel
- removeAttribute(String) - Method in interface org.keycloak.models.ClientScopeModel
- removeAttribute(String) - Method in interface org.keycloak.models.GroupModel
- removeAttribute(String) - Method in interface org.keycloak.models.KeycloakSession
- removeAttribute(String) - Method in interface org.keycloak.models.RealmModel
- removeAttribute(String) - Method in interface org.keycloak.models.RoleModel
- removeAttribute(String) - Method in interface org.keycloak.models.UserModel
- removeAttribute(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- removeAuthenticatedClientSessions(Collection<String>) - Method in interface org.keycloak.models.UserSessionModel
-
Removes authenticated client sessions for all clients whose UUID is present in
removedClientUUIDS
parameter. - removeAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- removeAuthenticationFlowBindingOverride(String) - Method in interface org.keycloak.models.ClientModel
- removeAuthenticationSessionByTabId(String) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Removes the authentication session specified by tab id from the root authentication session.
- removeAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
- removeAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
- removeAuthNote(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Removes the given authentication note.
- removeChild(GroupModel) - Method in interface org.keycloak.models.GroupModel
-
Automatically calls setParent() on the subGroup
- removeClient(String) - Method in interface org.keycloak.models.RealmModel
- removeClient(RealmModel, String) - Method in interface org.keycloak.models.ClientProvider
-
Removes given client from the given realm.
- removeClientInitialAccessModel(String) - Method in interface org.keycloak.models.RealmModel
- removeClientInitialAccessModel(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider
- removeClientNote(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Removes the given client note.
- removeClients(RealmModel) - Method in interface org.keycloak.models.ClientProvider
-
Removes all clients from the given realm.
- removeClientScope(String) - Method in interface org.keycloak.models.RealmModel
-
Removes client scope with given
id
from this realm. - removeClientScope(ClientScopeModel) - Method in interface org.keycloak.models.ClientModel
- removeClientScope(RealmModel, String) - Method in interface org.keycloak.models.ClientScopeProvider
-
Removes client scope from the given realm.
- removeClientScope(RealmModel, ClientModel, ClientScopeModel) - Method in interface org.keycloak.models.ClientProvider
-
Unassign clientScope from the client.
- removeClientScopes(RealmModel) - Method in interface org.keycloak.models.ClientScopeProvider
-
Removes all client scopes from the given realm.
- removeComponent(ComponentModel) - Method in interface org.keycloak.models.RealmModel
-
Removes given component.
- removeComponents(String) - Method in interface org.keycloak.models.RealmModel
-
Removes all components with given
parentId
- removeCompositeRole(RoleModel) - Method in interface org.keycloak.models.RoleModel
- removeDefaultClientScope(ClientScopeModel) - Method in interface org.keycloak.models.RealmModel
-
Removes given client scope from default or optional client scopes of this realm.
- removeDefaultGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
- removeDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
-
Deprecated.Default roles are now managed by
RealmModel.getDefaultRole()
. This method will be removed. - removeExpired(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Removes expired user sessions owned by this realm from this provider.
- removeExpired(RealmModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Deprecated.manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entities
- removeExpiredClientInitialAccess() - Method in interface org.keycloak.models.RealmProvider
-
Removes all expired client initial accesses from all realms.
- removeFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider
-
Removes federation link between the user and the identity provider given by its id
- removeGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel
- removeGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.GroupProvider
-
Removes the given group for the given realm.
- removeGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
GroupProvider
. - removeIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel
- removeIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
- removeImportedUsers(RealmModel, String) - Method in interface org.keycloak.models.UserProvider
-
Removes any imported users from a specific User Storage Provider.
- removeNextBackupCode() - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesSecretData
- removeNote(String) - Method in class org.keycloak.component.ComponentModel
- removeNote(String) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- removeNote(String) - Method in class org.keycloak.models.UserCredentialModel
- removeNote(String) - Method in interface org.keycloak.models.UserSessionModel
- removeOfflineUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
-
Removes the attached clientSessions as well
- removeProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
- removeRealm(String) - Method in interface org.keycloak.models.RealmProvider
-
Removes realm with the given id.
- removeRealmLocalizationTexts(String) - Method in interface org.keycloak.models.RealmModel
- removeRecoveryAuthnCode() - Method in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- removeRedirectUri(String) - Method in interface org.keycloak.models.ClientModel
- removeRequiredAction(String) - Method in interface org.keycloak.models.UserModel
- removeRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- removeRequiredAction(String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Removes a required action from the authentication session.
- removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel
- removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate
- removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Removes a required action from the authentication session.
- removeRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
- removeRole(RealmModel, RoleModel) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - removeRole(RoleModel) - Method in interface org.keycloak.models.RoleContainerModel
- removeRole(RoleModel) - Method in interface org.keycloak.models.RoleProvider
-
Removes given realm role from the given realm.
- removeRoles(ClientModel) - Method in interface org.keycloak.models.RoleProvider
-
Removes all roles from the given client.
- removeRoles(RealmModel) - Method in interface org.keycloak.models.RoleProvider
-
Removes all roles from the given realm.
- removeRootAuthenticationSession(RealmModel, RootAuthenticationSessionModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Removes provided root authentication session.
- removeStoredCredential(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore
-
Removes credential with the
id
for theuser
. - removeStoredCredentialById(String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Updates a credential of the entity with an updated
CredentialModel
. - removeUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserManager
- removeUser(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.UserRegistrationProvider
-
Called if user originated from this provider.
- removeUser(RealmModel, UserModel, UserProvider) - Method in class org.keycloak.models.UserManager
- removeUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserLoginFailureProvider
-
Removes a
UserLoginFailureModel
for the given realm and user id. - removeUserLoginFailure(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider
-
Deprecated.Use
removeUserLoginFailure
instead. - removeUserSession(RealmModel, UserSessionModel) - Method in interface org.keycloak.models.UserSessionProvider
-
This will remove attached ClientLoginSessionModels too
- removeUserSessions(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider
- removeUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider
- removeWebOrigin(String) - Method in interface org.keycloak.models.ClientModel
- REQUIRE_PUSHED_AUTHORIZATION_REQUESTS - Static variable in class org.keycloak.models.ParConfig
- REQUIRED - org.keycloak.models.AuthenticationExecutionModel.Requirement
- REQUIRED_ACTIONS - org.keycloak.sessions.CommonClientSessionModel.Action
- RequiredActionComparator() - Constructor for class org.keycloak.models.RequiredActionProviderModel.RequiredActionComparator
- RequiredActionProviderModel - Class in org.keycloak.models
- RequiredActionProviderModel() - Constructor for class org.keycloak.models.RequiredActionProviderModel
- RequiredActionProviderModel.RequiredActionComparator - Class in org.keycloak.models
- RequiredCredentialModel - Class in org.keycloak.models
- RequiredCredentialModel() - Constructor for class org.keycloak.models.RequiredCredentialModel
- requireResidentKey - Variable in class org.keycloak.models.WebAuthnPolicy
- REQUIRES_NEW - org.keycloak.models.KeycloakTransactionManager.JTAPolicy
-
A new JTA Transaction will be created when Keycloak TM begin() is called.
- resolve(URI) - Method in class org.keycloak.models.KeycloakUriInfo
- resolveLocale(RealmModel, UserModel) - Method in interface org.keycloak.locale.LocaleSelectorProvider
-
Resolve the locale which should be used for the request
- resolveLocale(UserModel) - Method in interface org.keycloak.models.KeycloakContext
- resolveProviderId(ClientModel) - Static method in class org.keycloak.storage.StorageId
-
Deprecated.Use
StorageId.providerId(String)
instead. - resolveProviderId(UserModel) - Static method in class org.keycloak.storage.StorageId
-
Deprecated.Use
StorageId.providerId(String)
instead. - RESOURCE_OWNER_PASSWORD_CREDENTIALS_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- RESOURCE_OWNER_PASSWORD_CREDENTIALS_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- restartSession(RealmModel) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Will completely restart whole state of authentication session.
- restartSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionModel
- revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.models.UserProvider
-
Remove a user consent given by the user id and client id
- ROLE - org.keycloak.provider.InvalidationHandler.ObjectType
- ROLE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- RoleContainerModel - Interface in org.keycloak.models
- RoleContainerModel.RoleRemovedEvent - Interface in org.keycloak.models
- roleLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Access to the legacy store is no longer possible via this method. Adjust your code according to the Keycloak 19 Upgrading Guide.
- RoleLookupProvider - Interface in org.keycloak.storage.role
-
Abstraction interface for lookup of both realm roles and client roles by id, name and description.
- RoleMapperModel - Interface in org.keycloak.models
- RoleMapperModel.Streams - Interface in org.keycloak.models
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- RoleModel - Interface in org.keycloak.models
- RoleModel.RoleNameChangeEvent - Interface in org.keycloak.models
- RoleModel.SearchableFields - Class in org.keycloak.models
- RoleProvider - Interface in org.keycloak.models
-
Provider of the role records.
- roles() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- roleStorageManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- RoleStorageProvider - Interface in org.keycloak.storage.role
-
Base interface for components that want to provide an alternative storage mechanism for roles
- RoleUtils - Class in org.keycloak.models.utils
- RoleUtils() - Constructor for class org.keycloak.models.utils.RoleUtils
- rollback() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- rollback() - Method in interface org.keycloak.models.KeycloakTransaction
- ROLLBACK_ONLY - org.keycloak.models.AbstractKeycloakTransaction.TransactionState
- rollbackImpl() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- RootAuthenticationSessionModel - Interface in org.keycloak.sessions
-
Represents usually one browser session with potentially many browser tabs.
- RootAuthenticationSessionModel.SearchableFields - Class in org.keycloak.sessions
- rpEntityName - Variable in class org.keycloak.models.WebAuthnPolicy
- rpId - Variable in class org.keycloak.models.WebAuthnPolicy
- RsaKeyMetadata - Class in org.keycloak.keys
- RsaKeyMetadata() - Constructor for class org.keycloak.keys.RsaKeyMetadata
- run(KeycloakSession) - Method in interface org.keycloak.models.KeycloakSessionTask
- run(KeycloakSession) - Method in interface org.keycloak.models.KeycloakSessionTaskWithResult
-
Computes a result.
S
- saveLocalizationText(RealmModel, String, String, String) - Method in interface org.keycloak.models.RealmProvider
- saveLocalizationTexts(RealmModel, String, Map<String, String>) - Method in interface org.keycloak.models.RealmProvider
- SCOPE - org.keycloak.rar.AuthorizationRequestSource
- SCOPE_MAPPING_ROLE - Static variable in class org.keycloak.models.ClientModel.SearchableFields
- ScopeContainerModel - Interface in org.keycloak.models
- SCRIPT_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- ScriptModel - Interface in org.keycloak.models
-
A representation of a Script with some additional meta-data.
- SEARCH - Static variable in interface org.keycloak.models.UserModel
- SearchableFields() - Constructor for class org.keycloak.models.ClientModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.ClientScopeModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.GroupModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.RealmModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.RoleModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.SingleUseObjectValueModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.UserLoginFailureModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.UserModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.models.UserSessionModel.SearchableFields
- SearchableFields() - Constructor for class org.keycloak.sessions.RootAuthenticationSessionModel.SearchableFields
- SearchableModelField<M> - Class in org.keycloak.storage
- SearchableModelField(String, Class<?>) - Constructor for class org.keycloak.storage.SearchableModelField
- searchClientByAttributes(Map<String, String>, Integer, Integer) - Method in interface org.keycloak.models.RealmModel
- searchClientByClientIdStream(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel
-
Search for clients by provided client's id.
- searchClientsByAttributes(RealmModel, Map<String, String>, Integer, Integer) - Method in interface org.keycloak.storage.client.ClientLookupProvider
- searchClientsByClientIdStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.client.ClientLookupProvider
-
Case-insensitive search for clients that contain the given string in their public client identifier.
- searchForClientRoles(RealmModel, ClientModel, String, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - searchForClientRolesStream(ClientModel, String, Integer, Integer) - Method in interface org.keycloak.storage.role.RoleLookupProvider
-
Case-insensitive search for client roles that contain the given string in their name or description.
- searchForGroupByNameStream(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel
-
Deprecated.
- searchForGroupByNameStream(RealmModel, String, Boolean, Integer, Integer) - Method in interface org.keycloak.storage.group.GroupLookupProvider
-
Returns the group hierarchy with the given string in name for the given realm.
- searchForGroupByNameStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.group.GroupLookupProvider
-
Deprecated.
- searchForRoles(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider
-
Deprecated.Use the corresponding method from
RoleProvider
. - searchForRolesStream(String, Integer, Integer) - Method in interface org.keycloak.models.RoleContainerModel
-
Searches roles by the given name.
- searchForRolesStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.role.RoleLookupProvider
-
Case-insensitive search for roles that contain the given string in their name or description.
- searchForUserByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for users that have a specific attribute with a specific value.
- searchForUserStream(RealmModel, String) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for users whose username, email, first name or last name contain any of the strings in
search
separated by whitespace. - searchForUserStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for users whose username, email, first name or last name contain any of the strings in
search
separated by whitespace. - searchForUserStream(RealmModel, Map<String, String>) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for user by parameter.
- searchForUserStream(RealmModel, Map<String, String>, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider
-
Searches for user by parameter.
- searchGroupsByAttributes(RealmModel, Map<String, String>, Integer, Integer) - Method in interface org.keycloak.storage.group.GroupLookupProvider
-
Returns the groups filtered by attribute names and attribute values for the given realm.
- secret - Variable in class org.keycloak.models.RequiredCredentialModel
- secret - Variable in class org.keycloak.provider.ProviderConfigProperty
- secret(boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
If turned on, this property is only writable and never readable.
- secret(String) - Static method in class org.keycloak.models.UserCredentialModel
- SECRET - Static variable in class org.keycloak.credential.CredentialModel
- SECRET - Static variable in class org.keycloak.models.RequiredCredentialModel
- SECRET - Static variable in class org.keycloak.models.UserCredentialModel
- SecretKeyMetadata - Class in org.keycloak.keys
- SecretKeyMetadata() - Constructor for class org.keycloak.keys.SecretKeyMetadata
- serializeKey() - Method in interface org.keycloak.models.SingleUseObjectKeyModel
- SERVICE_ACCOUNT_CLIENT - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
ID of the client corresponding to the service account
- SERVICE_ACCOUNT_TOKEN_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- SERVICE_ACCOUNT_TOKEN_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- sessions() - Method in interface org.keycloak.models.KeycloakSession
-
Returns a managed provider instance.
- setAcceptableAaguids(List<String>) - Method in class org.keycloak.models.WebAuthnPolicy
- setAccessCodeLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setAccessCodeLifespanLogin(int) - Method in interface org.keycloak.models.RealmModel
- setAccessCodeLifespanUserAction(int) - Method in interface org.keycloak.models.RealmModel
- setAccessTokenLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setAccessTokenLifespanForImplicitFlow(int) - Method in interface org.keycloak.models.RealmModel
- setAccountTheme(String) - Method in interface org.keycloak.models.RealmModel
- setAction(String) - Method in interface org.keycloak.sessions.CommonClientSessionModel
- setActionTokenGeneratedByAdminLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setActionTokenGeneratedByUserLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setActionTokenGeneratedByUserLifespan(String, Integer) - Method in interface org.keycloak.models.RealmModel
- setAdded(int) - Method in class org.keycloak.storage.user.SynchronizationResult
- setAddReadTokenRoleOnCreate(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setAdminEventsDetailsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setAdminEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setAdminTheme(String) - Method in interface org.keycloak.models.RealmModel
- setAlgorithm(String) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setAlgorithm(String) - Method in class org.keycloak.models.OTPPolicy
- setAlgorithm(String) - Method in class org.keycloak.models.UserCredentialModel
- setAlias(String) - Method in class org.keycloak.models.AuthenticationFlowModel
- setAlias(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
- setAlias(String) - Method in class org.keycloak.models.IdentityProviderModel
- setAlias(String) - Method in class org.keycloak.models.RequiredActionProviderModel
- setAlwaysDisplayInConsole(boolean) - Method in interface org.keycloak.models.ClientModel
- setAttestationConveyancePreference(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setAttestationStatementFormat(String) - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- setAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel
- setAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel
- setAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel
- setAttribute(String, Object) - Method in interface org.keycloak.models.ClientSessionContext
- setAttribute(String, Object) - Method in interface org.keycloak.models.KeycloakSession
- setAttribute(String, String) - Method in interface org.keycloak.models.ClientModel
- setAttribute(String, String) - Method in interface org.keycloak.models.ClientScopeModel
- setAttribute(String, String) - Method in interface org.keycloak.models.RealmModel
- setAttribute(String, List<String>) - Method in interface org.keycloak.models.GroupModel
- setAttribute(String, List<String>) - Method in interface org.keycloak.models.RoleModel
- setAttribute(String, List<String>) - Method in interface org.keycloak.models.UserModel
- setAttribute(String, List<String>) - Method in class org.keycloak.models.utils.UserModelDelegate
- setAuthenticateByDefault(boolean) - Method in class org.keycloak.models.IdentityProviderModel
-
Deprecated.
- setAuthenticatedUser(UserModel) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets authenticated user that is associated to the authentication session.
- setAuthenticationFlowBindingOverride(String, String) - Method in interface org.keycloak.models.ClientModel
- setAuthenticationSession(AuthenticationSessionModel) - Method in interface org.keycloak.models.KeycloakContext
- setAuthenticator(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setAuthenticatorAttachment(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setAuthenticatorConfig(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setAuthenticatorFlow(boolean) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setAuthNote(String, String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets the given authentication note to the given value.
- setAuthorizationDetailEntries(List<AuthorizationDetails>) - Method in class org.keycloak.rar.AuthorizationRequestContext
- setAuthorizationDetails(AuthorizationDetailsJSONRepresentation) - Method in class org.keycloak.rar.AuthorizationDetails
- setAuthRequestedUserHint(String) - Method in class org.keycloak.models.CibaConfig
- setAvoidSameAuthenticatorRegister(boolean) - Method in class org.keycloak.models.WebAuthnPolicy
- setBackchannelTokenDeliveryMode(String) - Method in class org.keycloak.models.CibaConfig
- setBaseUrl(String) - Method in interface org.keycloak.models.ClientModel
- setBearerOnly(boolean) - Method in interface org.keycloak.models.ClientModel
- setBrowserFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setBrowserSecurityHeaders(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
- setBruteForceProtected(boolean) - Method in interface org.keycloak.models.RealmModel
- setBuiltIn(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
- setBuiltIn(boolean) - Method in class org.keycloak.models.ClaimTypeModel
- setCertificate(Certificate) - Method in class org.keycloak.keys.RsaKeyMetadata
- setClient(ClientModel) - Method in interface org.keycloak.models.KeycloakContext
- setClientAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setClientAuthenticatorType(String) - Method in interface org.keycloak.models.ClientModel
- setClientId(String) - Method in interface org.keycloak.models.ClientModel
- setClientNote(String, String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets the given client note to the given value.
- setClientOfflineSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
- setClientOfflineSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setClientScope(ClientScopeModel) - Method in class org.keycloak.rar.AuthorizationDetails
- setClientScopes(Set<String>) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets client scope IDs to the authentication session.
- setClientSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
- setClientSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setCodeReusable(boolean) - Method in class org.keycloak.models.OTPPolicy
- setConfig(Map<String, String>) - Method in class org.keycloak.models.AuthenticatorConfigModel
- setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setConfig(Map<String, String>) - Method in class org.keycloak.models.IdentityProviderModel
- setConfig(Map<String, String>) - Method in class org.keycloak.models.ProtocolMapperModel
- setConfig(Map<String, String>) - Method in class org.keycloak.models.RequiredActionProviderModel
- setConfig(MultivaluedHashMap<String, String>) - Method in class org.keycloak.component.ComponentModel
- setConfig(MultivaluedHashMap<String, String>) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.Recommended to use
CredentialModel.setCredentialData(String)
instead and use the subtype of CredentialData specific to your credential - setConsentRequired(boolean) - Method in interface org.keycloak.models.ClientModel
- setConsentScreenText(String) - Method in interface org.keycloak.models.ClientScopeModel
- setCount(int) - Method in class org.keycloak.models.ClientInitialAccessModel
- setCounter(int) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setCounter(int) - Method in class org.keycloak.models.credential.dto.OTPCredentialData
- setCounter(long) - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- setCreatedDate(Long) - Method in class org.keycloak.credential.CredentialModel
- setCreatedDate(Long) - Method in class org.keycloak.models.UserConsentModel
- setCreatedTimestamp(Long) - Method in interface org.keycloak.models.UserModel
- setCreatedTimestamp(Long) - Method in class org.keycloak.models.utils.UserModelDelegate
- setCreateTimeout(int) - Method in class org.keycloak.models.WebAuthnPolicy
- setCredentialData(String) - Method in class org.keycloak.credential.CredentialModel
- setCredentialModel(CredentialModel) - Method in class org.keycloak.credential.CredentialMetadata
- setCurrentRefreshToken(String) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- setCurrentRefreshTokenUseCount(int) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- setDefaultAction(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
- setDefaultLocale(String) - Method in interface org.keycloak.models.RealmModel
- setDefaultRole(RoleModel) - Method in interface org.keycloak.models.RealmModel
-
Sets default role for this realm
- setDefaultSignatureAlgorithm(String) - Method in interface org.keycloak.models.RealmModel
- setDefaultValue(Object) - Method in class org.keycloak.provider.ProviderConfigProperty
- setDescription(String) - Method in class org.keycloak.models.AuthenticationFlowModel
- setDescription(String) - Method in interface org.keycloak.models.ClientModel
- setDescription(String) - Method in interface org.keycloak.models.ClientScopeModel
- setDescription(String) - Method in interface org.keycloak.models.RoleModel
- setDevice(String) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setDevice(String) - Method in class org.keycloak.models.UserCredentialModel
- setDigits(int) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setDigits(int) - Method in class org.keycloak.models.OTPPolicy
- setDirectAccessGrantsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
- setDirectGrantFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setDisplayName(String) - Method in class org.keycloak.models.IdentityProviderModel
- setDisplayName(String) - Method in interface org.keycloak.models.RealmModel
- setDisplayNameHtml(String) - Method in interface org.keycloak.models.RealmModel
- setDisplayOnConsentScreen(boolean) - Method in interface org.keycloak.models.ClientScopeModel
- setDockerAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setDuplicateEmailsAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setEditUsernameAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setEmail(String) - Method in interface org.keycloak.models.UserModel
-
Sets email for this user.
- setEmail(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setEmailTheme(String) - Method in interface org.keycloak.models.RealmModel
- setEmailVerified(boolean) - Method in interface org.keycloak.models.UserModel
- setEmailVerified(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
- setEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
- setEnabled(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setEnabled(boolean) - Method in class org.keycloak.models.RequiredActionProviderModel
- setEnabled(boolean) - Method in interface org.keycloak.models.UserModel
- setEnabled(boolean) - Method in class org.keycloak.models.utils.UserModelDelegate
- setEnabledEventTypes(Set<String>) - Method in interface org.keycloak.models.RealmModel
- setError(String) - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- setErrorDetail(String) - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- setErrorStatus(Response.Status) - Method in exception org.keycloak.services.clientpolicy.ClientPolicyException
- setEventsEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setEventsExpiration(long) - Method in interface org.keycloak.models.RealmModel
- setEventsListeners(Set<String>) - Method in interface org.keycloak.models.RealmModel
- setExecutionStatus(String, CommonClientSessionModel.ExecutionStatus) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets execution status of the authentication session.
- setExpiration(int) - Method in class org.keycloak.models.ClientInitialAccessModel
- setExpiresIn(Integer) - Method in class org.keycloak.models.CibaConfig
- setExpiresIn(String) - Method in class org.keycloak.models.CibaConfig
- setFailed(int) - Method in class org.keycloak.storage.user.SynchronizationResult
- setFailedLoginNotBefore(int) - Method in interface org.keycloak.models.UserLoginFailureModel
- setFailureFactor(int) - Method in interface org.keycloak.models.RealmModel
- setFederationLink(String) - Method in interface org.keycloak.models.UserModel
- setFederationLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setFirstBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
- setFirstName(String) - Method in interface org.keycloak.models.UserModel
- setFirstName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setFlowId(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setFormLabel(String) - Method in class org.keycloak.models.RequiredCredentialModel
- setFrontchannelLogout(boolean) - Method in interface org.keycloak.models.ClientModel
- setFullScopeAllowed(boolean) - Method in interface org.keycloak.models.ClientModel
- setGuiOrder(String) - Method in interface org.keycloak.models.ClientScopeModel
- setHashIterations(int) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setHelpText(String) - Method in class org.keycloak.provider.ProviderConfigProperty
- setHideOnLogin(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setId(String) - Method in class org.keycloak.component.ComponentModel
- setId(String) - Method in class org.keycloak.credential.CredentialModel
- setId(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
- setId(String) - Method in class org.keycloak.models.AuthenticatorConfigModel
- setId(String) - Method in class org.keycloak.models.ClaimTypeModel
- setId(String) - Method in class org.keycloak.models.ClientInitialAccessModel
- setId(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setId(String) - Method in class org.keycloak.models.ProtocolMapperModel
- setId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
- setIdentityProviderAlias(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setIdentityProviderMapper(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setIgnored(boolean) - Method in class org.keycloak.storage.user.SynchronizationResult
- setImplicitFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
- setIncludeInTokenScope(boolean) - Method in interface org.keycloak.models.ClientScopeModel
- setInfoMessage(String, String...) - Method in class org.keycloak.credential.CredentialMetadata
- setInitialCounter(int) - Method in class org.keycloak.models.OTPPolicy
- setInput(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
- setInternalId(String) - Method in class org.keycloak.models.IdentityProviderModel
- setInternationalizationEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setIsDynamicScope(boolean) - Method in interface org.keycloak.models.ClientScopeModel
- setJTAPolicy(KeycloakTransactionManager.JTAPolicy) - Method in interface org.keycloak.models.KeycloakTransactionManager
- setKid(String) - Method in class org.keycloak.keys.KeyMetadata
- setLabel(String) - Method in class org.keycloak.provider.ProviderConfigProperty
- setLastFailure(long) - Method in interface org.keycloak.models.UserLoginFailureModel
- setLastIPFailure(String) - Method in interface org.keycloak.models.UserLoginFailureModel
- setLastName(String) - Method in interface org.keycloak.models.UserModel
- setLastName(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setLastSessionRefresh(int) - Method in interface org.keycloak.models.UserSessionModel
- setLastUpdatedDate(Long) - Method in class org.keycloak.models.UserConsentModel
- setLinkOnly(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setLoginHint(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setLoginTheme(String) - Method in interface org.keycloak.models.RealmModel
- setLoginWithEmailAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setLookAheadWindow(int) - Method in class org.keycloak.models.OTPPolicy
- setManagementUrl(String) - Method in interface org.keycloak.models.ClientModel
- setMasterAdminClient(ClientModel) - Method in interface org.keycloak.models.RealmModel
- setMaxDeltaTimeSeconds(int) - Method in interface org.keycloak.models.RealmModel
- setMaxFailureWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
- setMinimumQuickLoginWaitSeconds(int) - Method in interface org.keycloak.models.RealmModel
- setName(String) - Method in class org.keycloak.component.ComponentModel
- setName(String) - Method in class org.keycloak.models.ClaimTypeModel
- setName(String) - Method in interface org.keycloak.models.ClientModel
- setName(String) - Method in interface org.keycloak.models.ClientScopeModel
- setName(String) - Method in interface org.keycloak.models.GroupModel
- setName(String) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setName(String) - Method in class org.keycloak.models.ProtocolMapperModel
- setName(String) - Method in interface org.keycloak.models.RealmModel
- setName(String) - Method in class org.keycloak.models.RequiredActionProviderModel
- setName(String) - Method in interface org.keycloak.models.RoleModel
- setName(String) - Method in class org.keycloak.provider.ProviderConfigProperty
- setNodeReRegistrationTimeout(int) - Method in interface org.keycloak.models.ClientModel
- setNotBefore(int) - Method in interface org.keycloak.models.ClientModel
- setNotBefore(int) - Method in interface org.keycloak.models.RealmModel
- setNotBeforeForUser(RealmModel, UserModel, int) - Method in interface org.keycloak.models.UserProvider
-
Sets the notBefore value for the given user
- setNote(String, Object) - Method in class org.keycloak.component.ComponentModel
- setNote(String, String) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- setNote(String, String) - Method in class org.keycloak.models.UserCredentialModel
- setNote(String, String) - Method in interface org.keycloak.models.UserSessionModel
- setOAuth2DeviceCodeLifespan(Integer) - Method in class org.keycloak.models.OAuth2DeviceConfig
- setOAuth2DevicePollingInterval(Integer) - Method in class org.keycloak.models.OAuth2DeviceConfig
- setOfflineSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
- setOfflineSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setOfflineSessionMaxLifespanEnabled(boolean) - Method in interface org.keycloak.models.RealmModel
- setOptions(List<String>) - Method in class org.keycloak.provider.ProviderConfigProperty
- setOTPPolicy(OTPPolicy) - Method in interface org.keycloak.models.RealmModel
- setParameters(Object[]) - Method in exception org.keycloak.component.ComponentValidationException
- setParameters(Object[]) - Method in exception org.keycloak.models.ModelException
- setParent(GroupModel) - Method in interface org.keycloak.models.GroupModel
-
You must also call addChild on the parent group, addChild on RealmModel if there is no parent group
- setParentFlow(String) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setParentId(String) - Method in class org.keycloak.component.ComponentModel
- setPassMaxAge(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setPasswordPolicy(PasswordPolicy) - Method in interface org.keycloak.models.RealmModel
- setPeriod(int) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setPeriod(int) - Method in class org.keycloak.models.OTPPolicy
- setPermanentLockout(boolean) - Method in interface org.keycloak.models.RealmModel
- setPoolingInterval(Integer) - Method in class org.keycloak.models.CibaConfig
- setPoolingInterval(String) - Method in class org.keycloak.models.CibaConfig
- setPostBrokerLoginFlowId(String) - Method in class org.keycloak.models.IdentityProviderModel
- setPriority(int) - Method in class org.keycloak.component.PrioritizedComponentModel
- setPriority(int) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setPriority(int) - Method in class org.keycloak.models.RequiredActionProviderModel
- setProtocol(String) - Method in interface org.keycloak.models.ClientModel
- setProtocol(String) - Method in interface org.keycloak.models.ClientScopeModel
- setProtocol(String) - Method in class org.keycloak.models.ProtocolMapperModel
- setProtocol(String) - Method in interface org.keycloak.sessions.CommonClientSessionModel
- setProtocolMapper(String) - Method in class org.keycloak.models.ProtocolMapperModel
- setProviderId(String) - Method in class org.keycloak.component.ComponentModel
- setProviderId(String) - Method in class org.keycloak.keys.KeyMetadata
- setProviderId(String) - Method in class org.keycloak.models.AuthenticationFlowModel
- setProviderId(String) - Method in class org.keycloak.models.IdentityProviderModel
- setProviderId(String) - Method in class org.keycloak.models.RequiredActionProviderModel
- setProviderPriority(long) - Method in class org.keycloak.keys.KeyMetadata
- setProviderType(String) - Method in class org.keycloak.component.ComponentModel
- setPublicClient(boolean) - Method in interface org.keycloak.models.ClientModel
- setPublicKey(PublicKey) - Method in class org.keycloak.keys.RsaKeyMetadata
- setQuickLoginCheckMilliSeconds(long) - Method in interface org.keycloak.models.RealmModel
- setReadOnly(boolean) - Method in class org.keycloak.provider.ProviderConfigProperty
- setRealm(RealmModel) - Method in interface org.keycloak.models.KeycloakContext
- setRedirectUri(String) - Method in interface org.keycloak.sessions.CommonClientSessionModel
- setRedirectUris(Set<String>) - Method in interface org.keycloak.models.ClientModel
- setRefreshTokenMaxReuse(int) - Method in interface org.keycloak.models.RealmModel
- setRegistrationAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setRegistrationEmailAsUsername(boolean) - Method in interface org.keycloak.models.RealmModel
- setRegistrationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setRegistrationToken(String) - Method in interface org.keycloak.models.ClientModel
- setRemainingCodes(int) - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- setRemainingCount(int) - Method in class org.keycloak.models.ClientInitialAccessModel
- setRememberMe(boolean) - Method in interface org.keycloak.models.RealmModel
- setRemoved(int) - Method in class org.keycloak.storage.user.SynchronizationResult
- setRequestUriLifespan(Integer) - Method in class org.keycloak.models.ParConfig
- setRequestUriLifespan(String) - Method in class org.keycloak.models.ParConfig
- setRequirement(AuthenticationExecutionModel.Requirement) - Method in class org.keycloak.models.AuthenticationExecutionModel
- setRequireResidentKey(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setResetCredentialsFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- setResetPasswordAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setRevokeRefreshToken(boolean) - Method in interface org.keycloak.models.RealmModel
- setRollbackOnly() - Method in class org.keycloak.models.AbstractKeycloakTransaction
- setRollbackOnly() - Method in interface org.keycloak.models.KeycloakTransaction
- setRootUrl(String) - Method in interface org.keycloak.models.ClientModel
- setRpEntityName(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setRpId(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setSalt(byte[]) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setSecret(boolean) - Method in class org.keycloak.models.RequiredCredentialModel
- setSecret(boolean) - Method in class org.keycloak.provider.ProviderConfigProperty
- setSecret(String) - Method in interface org.keycloak.models.ClientModel
- setSecretData(String) - Method in class org.keycloak.credential.CredentialModel
- setServiceAccountClientLink(String) - Method in interface org.keycloak.models.UserModel
- setServiceAccountClientLink(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
- setSignatureAlgorithm(List<String>) - Method in class org.keycloak.models.WebAuthnPolicy
- setSingleAttribute(String, String) - Method in interface org.keycloak.models.GroupModel
-
Set single value of specified attribute.
- setSingleAttribute(String, String) - Method in interface org.keycloak.models.RoleModel
- setSingleAttribute(String, String) - Method in interface org.keycloak.models.UserModel
-
Set single value of specified attribute.
- setSingleAttribute(String, String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setSmtpConfig(Map<String, String>) - Method in interface org.keycloak.models.RealmModel
- setSource(AuthorizationRequestSource) - Method in class org.keycloak.rar.AuthorizationDetails
- setSslRequired(SslRequired) - Method in interface org.keycloak.models.RealmModel
- setSsoSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel
- setSsoSessionIdleTimeoutRememberMe(int) - Method in interface org.keycloak.models.RealmModel
- setSsoSessionMaxLifespan(int) - Method in interface org.keycloak.models.RealmModel
- setSsoSessionMaxLifespanRememberMe(int) - Method in interface org.keycloak.models.RealmModel
- setStandardFlowEnabled(boolean) - Method in interface org.keycloak.models.ClientModel
- setState(UserSessionModel.State) - Method in interface org.keycloak.models.UserSessionModel
- setStatus(KeyStatus) - Method in class org.keycloak.keys.KeyMetadata
- setStoredVersion(String) - Method in interface org.keycloak.migration.MigrationModel
- setStoreToken(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setSubType(String) - Method in class org.keycloak.component.ComponentModel
- setSupportedLocales(Set<String>) - Method in interface org.keycloak.models.RealmModel
- setSurrogateAuthRequired(boolean) - Method in interface org.keycloak.models.ClientModel
- setSyncMode(IdentityProviderMapperSyncMode) - Method in class org.keycloak.models.IdentityProviderMapperModel
- setSyncMode(IdentityProviderSyncMode) - Method in class org.keycloak.models.IdentityProviderModel
- setTimestamp(int) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel
- setTimestamp(int) - Method in class org.keycloak.models.ClientInitialAccessModel
- setTimestamp(int) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel
-
Sets a timestamp when the root authentication session was created or updated.
- setToken(String) - Method in class org.keycloak.models.FederatedIdentityModel
- setTopLevel(boolean) - Method in class org.keycloak.models.AuthenticationFlowModel
- setTotalCodes(int) - Method in class org.keycloak.models.credential.dto.RecoveryAuthnCodesCredentialData
- setTransports(Set<String>) - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- setTrustEmail(boolean) - Method in class org.keycloak.models.IdentityProviderModel
- setType(String) - Method in class org.keycloak.credential.CredentialModel
- setType(String) - Method in class org.keycloak.models.OTPPolicy
- setType(String) - Method in class org.keycloak.models.RequiredCredentialModel
- setType(String) - Method in class org.keycloak.models.UserCredentialModel
- setType(String) - Method in class org.keycloak.provider.ProviderConfigProperty
- setType(ClaimTypeModel.ValueType) - Method in class org.keycloak.models.ClaimTypeModel
- SETUP_REQUIRED - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- setupClientPoliciesOnCreatedRealm(RealmModel) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute.
- setUpdated(int) - Method in class org.keycloak.storage.user.SynchronizationResult
- setUserLabel(String) - Method in class org.keycloak.credential.CredentialModel
- setUserManagedAccessAllowed(boolean) - Method in interface org.keycloak.models.RealmModel
- setUsername(String) - Method in interface org.keycloak.models.UserModel
-
Sets username for this user.
- setUsername(String) - Method in class org.keycloak.models.utils.UserModelDelegate
- setUserSessionNote(String, String) - Method in interface org.keycloak.sessions.AuthenticationSessionModel
-
Sets the given user session note to the given value.
- setUserVerificationRequirement(String) - Method in class org.keycloak.models.WebAuthnPolicy
- setValue(String) - Method in class org.keycloak.credential.CredentialModel
-
Deprecated.
- setValue(String) - Method in class org.keycloak.models.UserCredentialModel
- setVerifyEmail(boolean) - Method in interface org.keycloak.models.RealmModel
- setWaitIncrementSeconds(int) - Method in interface org.keycloak.models.RealmModel
- setWarningMessageDescription(String, String...) - Method in class org.keycloak.credential.CredentialMetadata
- setWarningMessageTitle(String, String...) - Method in class org.keycloak.credential.CredentialMetadata
- setWebAuthnPolicy(WebAuthnPolicy) - Method in interface org.keycloak.models.RealmModel
-
Set WebAuthn policy for 2-factor authentication
- setWebAuthnPolicyPasswordless(WebAuthnPolicy) - Method in interface org.keycloak.models.RealmModel
-
Set WebAuthn passwordless policy below.
- setWebOrigins(Set<String>) - Method in interface org.keycloak.models.ClientModel
- shallowClone() - Method in class org.keycloak.credential.CredentialModel
- signatureAlgorithm(TokenCategory) - Method in interface org.keycloak.models.TokenManager
- signatureAlgorithms - Variable in class org.keycloak.models.WebAuthnPolicy
- SINGLETON - Static variable in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator
- SINGLETON - Static variable in class org.keycloak.models.AuthenticationFlowModel.AuthenticationFlowComparator
- SINGLETON - Static variable in class org.keycloak.models.AuthenticatorConfigModel.AuthenticationConfigComparator
- SINGLETON - Static variable in class org.keycloak.models.RequiredActionProviderModel.RequiredActionComparator
- SingleUseObjectKeyModel - Interface in org.keycloak.models
- SingleUseObjectValueModel - Interface in org.keycloak.models
-
This model represents contents of an action token shareable among Keycloak instances in the cluster.
- SingleUseObjectValueModel.SearchableFields - Class in org.keycloak.models
- SKIPPED - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- Spi - Interface in org.keycloak.provider
- STARTED - org.keycloak.models.AbstractKeycloakTransaction.TransactionState
- STARTED_AT_NOTE - Static variable in interface org.keycloak.models.AuthenticatedClientSessionModel
- state - Variable in class org.keycloak.models.AbstractKeycloakTransaction
- StorageId - Class in org.keycloak.storage
- StorageId(String) - Constructor for class org.keycloak.storage.StorageId
- StorageId(String, String) - Constructor for class org.keycloak.storage.StorageId
- STRING - org.keycloak.models.ClaimTypeModel.ValueType
- STRING_CONFIG_TYPE - Static variable in interface org.keycloak.policy.PasswordPolicyProvider
- STRING_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
- StringUtil - Class in org.keycloak.utils
- StringUtil() - Constructor for class org.keycloak.utils.StringUtil
- SubComponentFactory<CreatedType,ProviderType extends Provider> - Interface in org.keycloak.component
-
Useful when you want to describe config properties that are effected by the parent ComponentModel
- SubjectCredentialManager - Interface in org.keycloak.models
-
Validates and manages the credentials of a known entity (for example, a user).
- SUCCESS - org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- supportsCredentialAuthenticationFor(String) - Method in interface org.keycloak.credential.CredentialAuthentication
- supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputUpdater
- supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputValidator
- SYNC_MODE - Static variable in class org.keycloak.models.IdentityProviderMapperModel
- SYNC_MODE - Static variable in class org.keycloak.models.IdentityProviderModel
- SynchronizationResult - Class in org.keycloak.storage.user
- SynchronizationResult() - Constructor for class org.keycloak.storage.user.SynchronizationResult
T
- TERMS_AND_CONDITIONS - org.keycloak.models.UserModel.RequiredAction
- TEXT_JAVASCRIPT - Static variable in interface org.keycloak.models.ScriptModel
-
MIME-Type for JavaScript
- TEXT_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty
-
textarea field
- theme() - Method in interface org.keycloak.models.KeycloakSession
-
Theme manager
- Theme - Interface in org.keycloak.theme
- Theme.Type - Enum in org.keycloak.theme
- ThemeManager - Interface in org.keycloak.models
- ThemeResourceProvider - Interface in org.keycloak.theme
-
A theme resource provider can be used to load additional templates and resources.
- ThemeResourceProviderFactory - Interface in org.keycloak.theme
- ThemeResourceSpi - Class in org.keycloak.theme
- ThemeResourceSpi() - Constructor for class org.keycloak.theme.ThemeResourceSpi
- ThemeSelectorProvider - Interface in org.keycloak.theme
- ThemeSelectorProviderFactory - Interface in org.keycloak.theme
- ThemeSelectorSpi - Class in org.keycloak.theme
- ThemeSelectorSpi() - Constructor for class org.keycloak.theme.ThemeSelectorSpi
- toBuilder() - Method in class org.keycloak.models.PasswordPolicy
- TOKEN_INTROSPECT - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TOKEN_REFRESH - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TOKEN_REFRESH_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TOKEN_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TOKEN_RESPONSE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TOKEN_REVOKE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- TokenManager - Interface in org.keycloak.models
- tokens() - Method in interface org.keycloak.models.KeycloakSession
-
Token manager
- TOS_URI - Static variable in interface org.keycloak.models.ClientModel
- toString() - Method in enum org.keycloak.credential.CredentialTypeMetadata.Category
- toString() - Method in class org.keycloak.models.credential.dto.WebAuthnCredentialData
- toString() - Method in class org.keycloak.models.credential.dto.WebAuthnSecretData
- toString() - Method in class org.keycloak.models.credential.WebAuthnCredentialModel
- toString() - Method in class org.keycloak.models.PasswordPolicy
- toString() - Method in class org.keycloak.rar.AuthorizationDetails
- toString() - Method in class org.keycloak.storage.SearchableModelField
- toString() - Method in class org.keycloak.storage.StorageId
- toString() - Method in class org.keycloak.storage.user.SynchronizationResult
- totp(String) - Static method in class org.keycloak.models.UserCredentialModel
- TOTP - Static variable in class org.keycloak.credential.CredentialModel
-
Deprecated.
- TOTP - Static variable in class org.keycloak.models.credential.OTPCredentialModel
- TOTP - Static variable in class org.keycloak.models.RequiredCredentialModel
- TOTP - Static variable in class org.keycloak.models.UserCredentialModel
-
Deprecated.
- TRANSIENT - org.keycloak.models.UserSessionModel.SessionPersistenceState
-
This userSession will be valid just for the single request.
- triggerOnEvent(ClientPolicyContext) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
execute a method for handling an event defined in
ClientPolicyEvent
. - TWO_FACTOR - org.keycloak.credential.CredentialTypeMetadata.Category
- type - Variable in class org.keycloak.models.OTPPolicy
- type - Variable in class org.keycloak.models.RequiredCredentialModel
- type - Variable in class org.keycloak.provider.ProviderConfigProperty
- type(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- type(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
-
Property type.
- TYPE - Static variable in class org.keycloak.models.credential.OTPCredentialModel
- TYPE - Static variable in class org.keycloak.models.credential.PasswordCredentialModel
- TYPE - Static variable in class org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
- TYPE_PASSWORDLESS - Static variable in class org.keycloak.models.credential.WebAuthnCredentialModel
- TYPE_TWOFACTOR - Static variable in class org.keycloak.models.credential.WebAuthnCredentialModel
U
- unlinkUsers(RealmModel, String) - Method in interface org.keycloak.models.UserProvider
-
Set federation link to
null
to imported users of a specific User Storage Provider - unregister(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager
- UNREGISTER - org.keycloak.services.clientpolicy.ClientPolicyEvent
- unregisterNode(String) - Method in interface org.keycloak.models.ClientModel
- UPDATE - org.keycloak.services.clientpolicy.ClientPolicyEvent
- UPDATE_EMAIL - org.keycloak.models.UserModel.RequiredAction
- UPDATE_PASSWORD - org.keycloak.models.UserModel.RequiredAction
- UPDATE_PROFILE - org.keycloak.models.UserModel.RequiredAction
- updateAction(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder
- updateAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel
- updateAuthenticatorConfig(AuthenticatorConfigModel) - Method in interface org.keycloak.models.RealmModel
- updateAuthenticatorExecution(AuthenticationExecutionModel) - Method in interface org.keycloak.models.RealmModel
- updateClient() - Method in interface org.keycloak.models.ClientModel
-
Deprecated.Do not use, to be removed
- updateClientPolicies(RealmModel, ClientPoliciesRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when updating client policies via Admin REST API, reads the json representation of the client policies and overrides the existing client policies set on the realm with them.
- updateClientProfiles(RealmModel, ClientProfilesRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when updating client profiles via Admin REST API, reads the json representation of the client profiles and overrides the existing client profiles set on the realm with them.
- updateComponent(ComponentModel) - Method in interface org.keycloak.models.RealmModel
-
Updates component model.
- updateConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.models.UserProvider
-
Update client scopes in the stored user consent
- updateCounter(int) - Method in class org.keycloak.models.credential.OTPCredentialModel
- updateCounter(long) - Method in class org.keycloak.models.credential.WebAuthnCredentialModel
- updateCredential(CredentialInput) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Updates a credential of the entity with the inputs provided by the entity.
- updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputUpdater
- updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Updates a credential.
- updateCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore
- updateCredentialLabel(String, String) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Update the label for a stored credentials chosen by the owner of the entity.
- updateCredentialLabel(RealmModel, UserModel, String, String) - Method in interface org.keycloak.models.UserCredentialManager
-
Deprecated.Updates the credential label and invalidates the cache for the user.
- UPDATED - org.keycloak.services.clientpolicy.ClientPolicyEvent
- updateDefaultRoles(String...) - Method in interface org.keycloak.models.RoleContainerModel
-
Deprecated.Default roles are now managed by
RealmModel.getDefaultRole()
. This method will be removed. - updateFederatedIdentity(RealmModel, UserModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider
-
Update details of association between the federatedUser and the idp given by the federatedIdentityModel
- updateIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel
- updateIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel
- updateLocaleCookie(String) - Method in interface org.keycloak.locale.LocaleUpdaterProvider
- updateLocalizationText(RealmModel, String, String, String) - Method in interface org.keycloak.models.RealmProvider
- updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId, Map<String, String>) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider
-
Requests update of authNotes of a root authentication session that is not owned by this instance but might exist somewhere in the cluster.
- updateProtocolMapper(ProtocolMapperModel) - Method in interface org.keycloak.models.ProtocolMapperContainerModel
- updateRealmModelFromRepresentation(RealmModel, RealmRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when importing a realm, or updating a realm, update model from the representation object
- updateRealmRepresentationFromModel(RealmModel, RealmRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager
-
when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies.
- updateRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel
- updateRequiredCredentials(Set<String>) - Method in interface org.keycloak.models.RealmModel
- updateStoredCredential(CredentialModel) - Method in interface org.keycloak.models.SubjectCredentialManager
-
Updates a credential of the entity with an updated
CredentialModel
. - updateUsersLocale(UserModel, String) - Method in interface org.keycloak.locale.LocaleUpdaterProvider
- UPPERNUM - Static variable in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- UrlType - Enum in org.keycloak.urls
- user(UserModel) - Method in class org.keycloak.credential.CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder
- USER - org.keycloak.provider.InvalidationHandler.ObjectType
- USER_CODE_VERIFICATION - org.keycloak.sessions.CommonClientSessionModel.Action
- USER_ID - Static variable in class org.keycloak.models.UserLoginFailureModel.SearchableFields
- USER_ID - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields
- USER_REQUEST_LOCALE - Static variable in interface org.keycloak.locale.LocaleSelectorProvider
- UserBulkUpdateProvider - Interface in org.keycloak.storage.user
-
This is an optional capability interface that is intended to be implemented by any
UserStorageProvider
that supports bulk operations. - userCache() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.The access to the UserCache interface is no longer possible here, and this method is about to be removed. Adjust your code according to the Keycloak 19 Upgrading Guide.
- UserConsentModel - Class in org.keycloak.models
- UserConsentModel(ClientModel) - Constructor for class org.keycloak.models.UserConsentModel
- userCredentialManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.Use
UserModel.credentialManager()
instead. - UserCredentialManager - Interface in org.keycloak.models
-
Deprecated.Instead of this class, use
UserModel.credentialManager()
instead. - UserCredentialManager.Streams - Interface in org.keycloak.models
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- UserCredentialModel - Class in org.keycloak.models
- UserCredentialModel() - Constructor for class org.keycloak.models.UserCredentialModel
- UserCredentialModel(String, String, String) - Constructor for class org.keycloak.models.UserCredentialModel
- UserCredentialModel(String, String, String, boolean) - Constructor for class org.keycloak.models.UserCredentialModel
- UserCredentialStore - Interface in org.keycloak.credential
- UserCredentialStore.Streams - Interface in org.keycloak.credential
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- USERINFO_REQUEST - org.keycloak.services.clientpolicy.ClientPolicyEvent
- userLocalStorage() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- UserLoginFailureModel - Interface in org.keycloak.models
- UserLoginFailureModel.SearchableFields - Class in org.keycloak.models
- UserLoginFailureProvider - Interface in org.keycloak.models
- UserLookupProvider - Interface in org.keycloak.storage.user
-
This is an optional capability interface that is intended to be implemented by any
UserStorageProvider
that supports basic user querying. - UserLookupProvider.Streams - Interface in org.keycloak.storage.user
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- UserManager - Class in org.keycloak.models
- UserManager(KeycloakSession) - Constructor for class org.keycloak.models.UserManager
- UserModel - Interface in org.keycloak.models
- UserModel.RequiredAction - Enum in org.keycloak.models
- UserModel.SearchableFields - Class in org.keycloak.models
- UserModel.Streams - Interface in org.keycloak.models
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- UserModel.UserRemovedEvent - Interface in org.keycloak.models
- UserModelDelegate - Class in org.keycloak.models.utils
-
Delegation pattern.
- UserModelDelegate(UserModel) - Constructor for class org.keycloak.models.utils.UserModelDelegate
- USERNAME - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for user's username in case sensitive mode.
- USERNAME - Static variable in interface org.keycloak.models.UserModel
- USERNAME_CASE_INSENSITIVE - Static variable in class org.keycloak.models.UserModel.SearchableFields
-
Search for user's username in case insensitive mode.
- UserProvider - Interface in org.keycloak.models
- UserProvider.Streams - Interface in org.keycloak.models
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- UserQueryProvider - Interface in org.keycloak.storage.user
-
This is an optional capability interface that is intended to be implemented by any
UserStorageProvider
that supports complex user querying. - UserQueryProvider.Streams - Interface in org.keycloak.storage.user
-
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directly
- UserRegistrationProvider - Interface in org.keycloak.storage.user
-
This is an optional capability interface that is intended to be implemented by any
UserStorageProvider
that supports addition of new users. - users() - Method in interface org.keycloak.models.KeycloakSession
-
A cached view of all users in system including users loaded by UserStorageProviders
- UserSessionModel - Interface in org.keycloak.models
- UserSessionModel.SearchableFields - Class in org.keycloak.models
- UserSessionModel.SessionPersistenceState - Enum in org.keycloak.models
-
Flag used when creating user session
- UserSessionModel.State - Enum in org.keycloak.models
- UserSessionProvider - Interface in org.keycloak.models
- userStorageManager() - Method in interface org.keycloak.models.KeycloakSession
-
Deprecated.
- userVerificationRequirement - Variable in class org.keycloak.models.WebAuthnPolicy
V
- validate(String, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
- validate(RealmModel) - Method in class org.keycloak.models.IdentityProviderModel
-
Validates this configuration.
- validate(RealmModel, UserModel, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider
- validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory
-
Called before a component is created or updated.
- validateHOTP(String, String, int) - Method in class org.keycloak.models.utils.HmacOTP
- validateSecret(String) - Method in interface org.keycloak.models.ClientModel
- valueOf(String) - Static method in enum org.keycloak.credential.CredentialTypeMetadata.Category
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.AbstractKeycloakTransaction.TransactionState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.IdentityProviderMapperSyncMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.IdentityProviderSyncMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.KeycloakTransactionManager.JTAPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.UserModel.RequiredAction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.UserSessionModel.SessionPersistenceState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.models.UserSessionModel.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.provider.InvalidationHandler.ObjectType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.rar.AuthorizationRequestSource
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.services.clientpolicy.ClientPolicyEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.sessions.CommonClientSessionModel.Action
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.theme.Theme.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.keycloak.urls.UrlType
-
Returns the enum constant of this type with the specified name.
- valueOfInteger(Integer) - Static method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
- valueOfInteger(Integer) - Static method in enum org.keycloak.models.UserSessionModel.State
- valueOfInteger(Integer) - Static method in enum org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
- values() - Static method in enum org.keycloak.credential.CredentialTypeMetadata.Category
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.AbstractKeycloakTransaction.TransactionState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.AuthenticationExecutionModel.Requirement
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.ClaimTypeModel.ValueType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.CredentialValidationOutput.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.IdentityProviderMapperSyncMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.IdentityProviderSyncMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.KeycloakTransactionManager.JTAPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.UserModel.RequiredAction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.UserSessionModel.SessionPersistenceState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.models.UserSessionModel.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.provider.InvalidationHandler.ObjectType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.rar.AuthorizationRequestSource
-
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.ClientPolicyEvent
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.sessions.CommonClientSessionModel.Action
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.sessions.CommonClientSessionModel.ExecutionStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.theme.Theme.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.keycloak.urls.UrlType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- vault() - Method in interface org.keycloak.models.KeycloakSession
-
Vault transcriber
- VaultCharSecret - Interface in org.keycloak.vault
-
A
CharBuffer
based representation of the secret obtained from the vault that supports automated cleanup of memory. - VaultKeyResolver - Interface in org.keycloak.vault
-
VaultKeyResolver
is aBiFunction
whose implementation of theBiFunction.apply(Object, Object)
method takes twoString
s representing the realm name and the key name (as used in${vault.key}
expressions) and returns anotherString
representing the final constructed key that is to be used when obtaining secrets from the vault. - VaultProvider - Interface in org.keycloak.vault
-
Provider interface for a vault.
- VaultProviderFactory - Interface in org.keycloak.vault
- VaultRawSecret - Interface in org.keycloak.vault
-
Raw representation of the secret obtained from vault that supports automated cleanup of memory.
- VaultSpi - Class in org.keycloak.vault
-
SPI for a low-level vault access.
- VaultSpi() - Constructor for class org.keycloak.vault.VaultSpi
- VaultStringSecret - Interface in org.keycloak.vault
-
A
String
based representation of the secret obtained from the vault that supports automated cleanup of memory. - VaultTranscriber - Interface in org.keycloak.vault
-
A facade to the configured vault provider that exposes utility methods for obtaining the vault secrets in different formats (such as
VaultRawSecret
,VaultCharSecret
orVaultStringSecret
). - verify(String, CredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
-
Deprecated.Exists due the backwards compatibility. It is recommended to use
PasswordHashProvider.verify(String, PasswordCredentialModel)
- verify(String, PasswordCredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider
- VERIFY_EMAIL - org.keycloak.models.UserModel.RequiredAction
- VERIFY_PROFILE - org.keycloak.models.UserModel.RequiredAction
- verifyRecoveryCodeInput(String, String) - Static method in class org.keycloak.models.utils.RecoveryAuthnCodesUtils
- VIEW - org.keycloak.services.clientpolicy.ClientPolicyEvent
W
- WebAuthnCredentialData - Class in org.keycloak.models.credential.dto
- WebAuthnCredentialData(String, String, long, String, String, String, Set<String>) - Constructor for class org.keycloak.models.credential.dto.WebAuthnCredentialData
- WebAuthnCredentialModel - Class in org.keycloak.models.credential
- WebAuthnPolicy - Class in org.keycloak.models
- WebAuthnPolicy() - Constructor for class org.keycloak.models.WebAuthnPolicy
- WebAuthnPolicy(List<String>) - Constructor for class org.keycloak.models.WebAuthnPolicy
- WebAuthnSecretData - Class in org.keycloak.models.credential.dto
- WebAuthnSecretData() - Constructor for class org.keycloak.models.credential.dto.WebAuthnSecretData
- WELCOME - org.keycloak.theme.Theme.Type
X
- X509CERTIFICATE - Static variable in interface org.keycloak.models.ClientModel
_
- _ALL_ - org.keycloak.provider.InvalidationHandler.ObjectType
All Classes All Packages