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

A

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

AbstractUserAdapter - Class in org.keycloak.storage.adapter

This abstract class provides implementations for everything but getUsername().

AbstractUserAdapter(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapter

AbstractUserAdapter.Streams - Class in org.keycloak.storage.adapter

The AbstractUserAdapter.Streams class extends the AbstractUserAdapter abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.

AbstractUserAdapterFederatedStorage - Class in org.keycloak.storage.adapter

Assumes everything is managed by federated storage except for username.

AbstractUserAdapterFederatedStorage(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

AbstractUserAdapterFederatedStorage.Streams - Class in org.keycloak.storage.adapter

The AbstractUserAdapterFederatedStorage.Streams class extends the AbstractUserAdapterFederatedStorage abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.

acceptableAaguids - Variable in class org.keycloak.models.WebAuthnPolicy

ActionTokenKeyModel - Interface in org.keycloak.models

ActionTokenValueModel - Interface in org.keycloak.models

This model represents contents of an action token shareable among Keycloak instances in the cluster.

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(RealmModel, String) - Method in interface org.keycloak.models.ClientProvider

Adds a client with given clientId to the given realm.

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(String) - Method in interface org.keycloak.models.RealmModel

addClient(String, String) - Method in interface org.keycloak.models.RealmModel

addClient(RealmModel, String, String) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

addClient(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

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.

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.

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.

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.

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.

addConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

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

addFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

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, 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.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(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel

addRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate

addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate

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.sessions.AuthenticationSessionModel

Adds a required action to the authentication session.

addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

addRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

addRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

addRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

addRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel

addRequiredCredential(String) - Method in interface org.keycloak.models.RealmModel

addRole(String) - Method in interface org.keycloak.models.RoleContainerModel

addRole(String, String) - Method in interface org.keycloak.models.RoleContainerModel

addScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel

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, String, boolean, boolean) - Method in interface org.keycloak.models.UserProvider

Adds a new user into the storage.

addUser(RealmModel, String) - Method in interface org.keycloak.storage.user.UserRegistrationProvider

All storage providers that implement this interface will be looped through.

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

algorithm - Variable in class org.keycloak.models.OTPPolicy

algorithm - Variable in class org.keycloak.models.utils.HmacOTP

ALLOWED_CLOCK_SKEW - Static variable in class org.keycloak.models.IdentityProviderModel

appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true

appendDefaultGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Should the realm's default groups be appended to getGroups() call? If your storage provider is not managing group mappings then it is recommended that this method return true

appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true

appendDefaultRolesToRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Should the realm's default roles be appended to getRoleMappings() call? If your storage provider is not managing all role mappings then it is recommended that this method return true

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

attestationConveyancePreference - Variable in class org.keycloak.models.WebAuthnPolicy

ATTRIBUTE - Static variable in class org.keycloak.models.UserModel.SearchableFields

Search for attribute value.

authenticate(RealmModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialAuthentication

authenticate(KeycloakSession, RealmModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager

Given a CredentialInput, authenticate the user.

AuthenticatedClientSessionModel - Interface in org.keycloak.models

AuthenticatedClientSessionModel.SearchableFields - Class 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

avoidSameAuthenticatorRegister - Variable in class org.keycloak.models.WebAuthnPolicy

B

Base32 - Class in org.keycloak.models.utils

Base32 - encodes and decodes RFC3548 Base32 (see http://www.faqs.org/rfcs/rfc3548.html )

Base32() - Constructor for class org.keycloak.models.utils.Base32

begin() - Method in class org.keycloak.models.AbstractKeycloakTransaction

begin() - Method in interface org.keycloak.models.KeycloakTransaction

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(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() - Static method in class org.keycloak.models.PasswordPolicy

build(KeycloakSession) - Method in class org.keycloak.models.PasswordPolicy.Builder

build() - Method in class org.keycloak.provider.ProviderConfigurationBuilder

Create the list.

builder() - Static method in class org.keycloak.credential.CredentialTypeMetadata

builder() - Static method in class org.keycloak.credential.CredentialTypeMetadataContext

BUILT_IN - Static variable in class org.keycloak.models.RequiredCredentialModel

C

CACHE_INVALID_BEFORE - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

CACHE_POLICY - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel - Class in org.keycloak.storage

CacheableStorageProviderModel() - Constructor for class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.CacheableStorageProviderModel

CacheableStorageProviderModel.CachePolicy - Enum in org.keycloak.storage

CachedObject - Interface in org.keycloak.models.cache

CachedUserModel - Interface in org.keycloak.models.cache

Cached users will implement this interface

CachedUserModel.Streams - Interface in org.keycloak.models.cache

The CachedUserModel.Streams interface differs from CachedUserModel in that it extends the UserModel.Streams interface, allowing implementations of CachedUserModel to focus on the Stream-based methods in the UserModel interface.

category(CredentialTypeMetadata.Category) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder

cekManagementAlgorithm(TokenCategory) - Method in interface org.keycloak.models.TokenManager

CHANGED_SYNC_PERIOD - Static variable in class org.keycloak.storage.UserStorageProviderModel

CIBA_AUTH_REQUESTED_USER_HINT - 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

CibaConfig - Class in org.keycloak.models

CibaConfig(RealmModel) - Constructor for class org.keycloak.models.CibaConfig

ClaimTypeModel - Class in org.keycloak.models

ClaimTypeModel(ClaimTypeModel) - Constructor for class org.keycloak.models.ClaimTypeModel

ClaimTypeModel(String, String, boolean, ClaimTypeModel.ValueType) - Constructor for class org.keycloak.models.ClaimTypeModel

ClaimTypeModel() - Constructor for class org.keycloak.models.ClaimTypeModel

ClaimTypeModel.ValueType - Enum in org.keycloak.models

clear() - Method in interface org.keycloak.models.cache.UserCache

Clear cache entirely.

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_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.AuthenticatedClientSessionModel.SearchableFields

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

ClientInitialAccessModel - Class in org.keycloak.models

ClientInitialAccessModel() - Constructor for class org.keycloak.models.ClientInitialAccessModel

clientLocalStorage() - Method in interface org.keycloak.models.KeycloakSession

Keycloak specific local storage for clients.

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.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, Response.Status) - 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, 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

Keycloak specific local storage for client scopes.

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

ClientSessionContext - Interface in org.keycloak.models

Request-scoped context object

clientStorageManager() - Method in interface org.keycloak.models.KeycloakSession

ClientStorageProvider - Interface in org.keycloak.storage.client

Base interface for components that want to provide an alternative storage mechanism for clients This is currently a private incomplete SPI.

ClientStorageProviderModel - Class in org.keycloak.storage.client

Stored configuration of a Client Storage provider instance.

ClientStorageProviderModel() - Constructor for class org.keycloak.storage.client.ClientStorageProviderModel

ClientStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.client.ClientStorageProviderModel

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.storage.UserStorageProviderFactory

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

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

commonConfig() - Static method in class org.keycloak.storage.UserStorageProviderSpi

comparator - Static variable in class org.keycloak.component.PrioritizedComponentModel

compare(AuthenticationExecutionModel, AuthenticationExecutionModel) - Method in class org.keycloak.models.AuthenticationExecutionModel.ExecutionComparator

compare(AuthenticationFlowModel, AuthenticationFlowModel) - Method in class org.keycloak.models.AuthenticationFlowModel.AuthenticationFlowComparator

compare(AuthenticatorConfigModel, AuthenticatorConfigModel) - Method in class org.keycloak.models.AuthenticatorConfigModel.AuthenticationConfigComparator

compare(OM, OM) - Method in class org.keycloak.models.OrderedModel.OrderedModelComparator

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_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(Throwable) - Constructor for exception org.keycloak.component.ComponentValidationException

ComponentValidationException(String, Throwable, boolean, boolean) - Constructor for exception org.keycloak.component.ComponentValidationException

config - Variable in class org.keycloak.models.IdentityProviderMapperModel

config - Variable in class org.keycloak.models.ProtocolMapperModel

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

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(KeycloakSession, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory

create(KeycloakSession) - Method in interface org.keycloak.component.ComponentFactory

create(String, String, String, String, String, String, long, String) - Static method in class org.keycloak.models.credential.WebAuthnCredentialModel

create() - Method in interface org.keycloak.models.KeycloakSessionFactory

create() - Static method in class org.keycloak.provider.ProviderConfigurationBuilder

create(KeycloakSession) - Method in interface org.keycloak.provider.ProviderFactory

create(KeycloakSession, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

called per Keycloak transaction.

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, T) - Method in interface org.keycloak.credential.CredentialProvider

createCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore

createCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

createCredentialThroughProvider(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.models.UserCredentialManager

Creates a credential from the credentialModel, by looping through the providers to find a match for the type

created - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

CREATED_TIMESTAMP_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

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.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(PasswordCredentialData, PasswordSecretData) - Static method in class org.keycloak.models.credential.PasswordCredentialModel

createFromValues(String, byte[], int, String) - Static method in class org.keycloak.models.credential.PasswordCredentialModel

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, 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, 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, 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(String) - Method in interface org.keycloak.models.RealmModel

createGroup(String, String) - Method in interface org.keycloak.models.RealmModel

createGroup(String, GroupModel) - Method in interface org.keycloak.models.RealmModel

createGroup(String, String, GroupModel) - Method in interface org.keycloak.models.RealmModel

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.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

createGroup(RealmModel, String, GroupModel) - 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.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

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(String, RealmModel) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider

Deprecated.

Use AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel, String) createRootAuthenticationSession} instead.

createRootAuthenticationSession(RealmModel, String) - Method in interface org.keycloak.sessions.AuthenticationSessionProvider

Creates a new root authentication session specified by the provided realm and id.

createTimeout - Variable in class org.keycloak.models.WebAuthnPolicy

createTOTP(String, int, int, String) - Static method in class org.keycloak.models.credential.OTPCredentialModel

createUserSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionProvider

createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState) - 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

The CredentialInputUpdater.Streams interface makes all collection-based methods in CredentialInputUpdater default by providing implementations that delegate to the Stream-based variants instead of the other way around.

CredentialInputValidator - Interface in org.keycloak.credential

Implentations of this interface can validate CredentialInput, i.e.

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

dailyEvictionBoundary(int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

dailyTimeout(int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

decode(String, Class<T>) - Method in interface org.keycloak.models.TokenManager

Decodes and verifies the token, or null if the token was invalid

decode(String) - Static method in class org.keycloak.models.utils.Base32

Decodes the given Base32 String to a raw byte array.

decodeClientJWT(String, 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_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_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_POLICY - Static variable in class org.keycloak.models.OTPPolicy

DEFAULT_POLICY - Static variable in class org.keycloak.models.WebAuthnPolicy

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

deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

deleteRoleMapping(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

deleteRoleMapping(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

deleteScopeMapping(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel

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.

digits - Variable in class org.keycloak.models.OTPPolicy

DIRECT_GRANT_BINDING - Static variable in interface org.keycloak.models.AuthenticationFlowBindings

disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputUpdater

disableCredentialType(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager

Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.

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

E

EMAIL - Static variable in interface org.keycloak.models.UserModel

EMAIL - Static variable in class org.keycloak.models.UserModel.SearchableFields

EMAIL_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

EMAIL_VERIFIED - Static variable in interface org.keycloak.models.UserModel

EMAIL_VERIFIED - Static variable in class org.keycloak.models.UserModel.SearchableFields

EMAIL_VERIFIED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

empty() - Static method in class org.keycloak.models.PasswordPolicy

empty() - Static method in class org.keycloak.storage.user.SynchronizationResult

ENABLED - Static variable in interface org.keycloak.models.UserModel

ENABLED - Static variable in class org.keycloak.models.UserModel.SearchableFields

ENABLED - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

ENABLED - Static variable in class org.keycloak.storage.client.ClientStorageProviderModel

ENABLED_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

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

encode(byte[]) - Static method in class org.keycloak.models.utils.Base32

Encodes byte array to Base32 String.

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.storage.adapter.AbstractUserAdapter

equals(Object) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

equals(Object) - Method in class org.keycloak.storage.SearchableModelField

evict(RealmModel, UserModel) - Method in interface org.keycloak.models.cache.UserCache

Evict user from cache.

evict(RealmModel) - Method in interface org.keycloak.models.cache.UserCache

Evict users of a specific realm

EVICTION_DAY - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

EVICTION_HOUR - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

EVICTION_MINUTE - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

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

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

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.

FIRST_NAME - Static variable in interface org.keycloak.models.UserModel

FIRST_NAME - Static variable in class org.keycloak.models.UserModel.SearchableFields

FIRST_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

FORCE_EXPIRED_ID - Static variable in class org.keycloak.models.PasswordPolicy

formLabel - Variable in class org.keycloak.models.RequiredCredentialModel

FreeOTP() - Constructor for class org.keycloak.models.OTPPolicy.FreeOTP

fromAuthSession(AuthenticationSessionModel) - Static method in class org.keycloak.sessions.AuthenticationSessionCompoundId

fromString(String) - Static method in enum org.keycloak.models.UserSessionModel.SessionPersistenceState

FULL_SYNC_PERIOD - Static variable in class org.keycloak.storage.UserStorageProviderModel

G

generateHOTP(String, int) - Method in class org.keycloak.models.utils.HmacOTP

generateOTP(String, String, int, String) - Method in class org.keycloak.models.utils.HmacOTP

This method generates an OTP value for the given set of parameters.

generateSecret() - Static method in class org.keycloak.models.UserCredentialModel

generateSecret(int) - Static method in class org.keycloak.models.utils.HmacOTP

get(String) - Method in class org.keycloak.component.ComponentModel

get(String, String) - Method in class org.keycloak.component.ComponentModel

get(String, int) - Method in class org.keycloak.component.ComponentModel

get(String, long) - Method in class org.keycloak.component.ComponentModel

get(String, boolean) - Method in class org.keycloak.component.ComponentModel

get(String) - Method in class org.keycloak.models.PasswordPolicy.Builder

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.

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 interface org.keycloak.models.ActionTokenKeyModel

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 interface org.keycloak.models.ActionTokenKeyModel

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.getCredentialData().getAlgorithm() or OTPCredentialModel.getCredentialData().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.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

getAlwaysDisplayInConsoleClients(RealmModel) - Method in interface org.keycloak.models.ClientProvider

Deprecated.

use the stream variant instead

getAlwaysDisplayInConsoleClients() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getAlwaysDisplayInConsoleClientsStream instead.

getAlwaysDisplayInConsoleClients(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

getAlwaysDisplayInConsoleClientsStream(RealmModel) - Method in interface org.keycloak.models.ClientProvider

Returns a stream of clients that are expected to always show up in account console.

getAlwaysDisplayInConsoleClientsStream() - Method in interface org.keycloak.models.RealmModel

Returns clients which are always displayed in the admin console as a stream.

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, Class<T>) - Method in interface org.keycloak.models.ClientSessionContext

getAttribute(String) - Method in interface org.keycloak.models.GroupModel

Deprecated.

Use getAttributeStream instead.

getAttribute(String) - Method in interface org.keycloak.models.GroupModel.Streams

getAttribute(String) - Method in interface org.keycloak.models.KeycloakSession

getAttribute(String, Class<T>) - Method in interface org.keycloak.models.KeycloakSession

getAttribute(String) - Method in interface org.keycloak.models.RealmModel

getAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel

getAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel

getAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel

getAttribute(String) - Method in interface org.keycloak.models.RoleModel

Deprecated.

Use getAttributeStream instead.

getAttribute(String) - Method in interface org.keycloak.models.UserModel

Deprecated.

Use getAttributeStream instead.

getAttribute(String) - Method in interface org.keycloak.models.UserModel.Streams

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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

getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getAttributes() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getAttributes(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

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.GroupModel.Streams

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 interface org.keycloak.models.UserModel.Streams

getAttributeStream(String) - Method in class org.keycloak.models.utils.UserModelDelegate

getAttributeStream(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getAttributeStream(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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

getAuthenticationExecutions(String) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getAuthenticationExecutionsStream instead.

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

getAuthenticationFlows() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getAuthenticationFlowsStream instead.

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

getAuthenticatorConfigs() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getAuthenticatorConfigsStream instead.

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.

getAuthRequestedUserHint() - Method in class org.keycloak.models.CibaConfig

getAuthServerUrl() - Method in interface org.keycloak.models.KeycloakContext

getAuthStatus() - Method in class org.keycloak.models.CredentialValidationOutput

getBackchannelTokenDeliveryMode(ClientModel) - Method in class org.keycloak.models.CibaConfig

getBackchannelTokenDeliveryMode() - 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

getCachedWith() - Method in interface org.keycloak.models.cache.CachedUserModel

Returns a map that contains custom things that are cached along with this model.

getCacheInvalidBefore() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getCachePolicy() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedObject

getCacheTimestamp() - Method in interface org.keycloak.models.cache.CachedUserModel

When was the model was loaded from database.

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

getChangedSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel

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(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

getClientByClientId(RealmModel, String) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Exact search for a client by its public client identifier.

getClientByClientId(String, RealmModel) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Deprecated.

Use ClientLookupProvider.getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.

getClientById(String) - Method in interface org.keycloak.models.RealmModel

getClientById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

getClientById(RealmModel, String) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Exact search for a client by its internal ID.

getClientById(String, RealmModel) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Deprecated.

Use ClientLookupProvider.getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.

getClientId() - Method in interface org.keycloak.models.ClientModel

Returns client ID as defined by the user.

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.

getClientPoliciesJsonString(RealmModel) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

returns the json representation of the client policies set on the realm.

getClientPoliciesOnKeycloakApp() - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

returns the json representation of the builtin client policies set on keycloak application.

getClientProfiles(RealmModel) - 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.

getClientProfilesJsonString(RealmModel) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

returns the json representation of the client profiles set on the realm.

getClientProfilesOnKeycloakApp() - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

returns the json representation of the builtin client profiles set on keycloak application.

getClientRole(RealmModel, ClientModel, String) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from RoleProvider.

getClientRole(ClientModel, String) - Method in interface org.keycloak.storage.role.RoleLookupProvider

Exact search for a client role by given name.

getClientRoleMappings(ClientModel) - Method in interface org.keycloak.models.RoleMapperModel

Deprecated.

Use getClientRoleMappingsStream instead.

getClientRoleMappings(ClientModel) - Method in interface org.keycloak.models.RoleMapperModel.Streams

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getClientRoleMappings(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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 interface org.keycloak.models.RoleMapperModel.Streams

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.models.utils.UserModelDelegate

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getClientRoleMappingsStream(ClientModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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.

getClients(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.ClientProvider

Deprecated.

use the stream variant instead

getClients(RealmModel) - Method in interface org.keycloak.models.ClientProvider

Deprecated.

use the stream variant instead Effectively the same as the call getClients(realm, null, null).

getClients() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getClientsStream instead.

getClients(Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getClientsStream instead.

getClients(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

getClients(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

getClientScope() - Method in interface org.keycloak.models.ClientScopeModel.ClientScopeRemovedEvent

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(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() - Method in interface org.keycloak.models.ClientSessionContext

Deprecated.

Use getClientScopesStream instead.

getClientScopes() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getClientScopesStream instead.

getClientScopes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel

Gets client scope IDs from the authentication session.

getClientScopes(RealmModel, ClientModel, boolean) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Return all default scopes (if defaultScope is true) or all optional scopes (if defaultScope is false) linked with the client

getClientScopesStream(RealmModel) - Method in interface org.keycloak.models.ClientScopeProvider

Returns all the client scopes of the given realm as a stream.

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.

getClientsCount(RealmModel) - Method in interface org.keycloak.models.ClientProvider

Returns number of clients in the given realm

getClientsCount() - Method in interface org.keycloak.models.RealmModel

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, UUID, boolean) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.

getClientSession(UserSessionModel, ClientModel, String, boolean) - Method in interface org.keycloak.models.UserSessionProvider

getClientSessionId() - Method in class org.keycloak.models.SamlArtifactSessionMappingModel

getClientSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel

getClientSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel

getClientsStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.ClientProvider

Returns the clients of the given realm as a stream.

getClientsStream(RealmModel) - Method in interface org.keycloak.models.ClientProvider

Returns all the clients of the given realm as a stream.

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.

getClientStorageProviders() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getClientStorageProvidersStream instead.

getClientStorageProvidersStream() - Method in interface org.keycloak.models.RealmModel

Returns sorted ClientStorageProviderModel 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.

getCommonProviderConfigProperties() - Method in interface org.keycloak.component.ComponentFactory

These are config properties that are common across all implementation of this component type

getCommonProviderConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory

configuration properties that are common across all UserStorageProvider implementations

getComponent(String) - Method in interface org.keycloak.models.RealmModel

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.

getComponents(String, String) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getComponentsStream instead.

getComponents(String) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getComponentsStream instead.

getComponents() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getComponentsStream instead.

getComponentsStream(String, String) - Method in interface org.keycloak.models.RealmModel

Returns stream of ComponentModels for specific parentId and providerType.

getComponentsStream(String) - Method in interface org.keycloak.models.RealmModel

Returns stream of ComponentModels for specific parentId.

getComponentsStream() - Method in interface org.keycloak.models.RealmModel

Returns stream of component models.

getComposites() - Method in interface org.keycloak.models.RoleModel

Deprecated.

Use getCompositesStream instead.

getCompositesStream() - Method in interface org.keycloak.models.RoleModel

Returns all composite roles as a stream.

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

getConfigMap(String) - Method in class org.keycloak.models.IdentityProviderMapperModel

getConfigProperties(RealmModel, ComponentModel) - Method in interface org.keycloak.component.SubComponentFactory

getConfigProperties() - Method in interface org.keycloak.provider.ConfiguredProvider

getConfigProperties() - Method in interface org.keycloak.storage.UserStorageProviderFactory

getConfiguredUserStorageCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager

Deprecated.

Use getConfiguredUserStorageCredentialTypesStream instead.

getConfiguredUserStorageCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager.Streams

getConfiguredUserStorageCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager

Obtains the credential types provided by the user storage where the specified user is stored.

getConfiguredUserStorageCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager.Streams

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

getConsentByClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

getConsents(RealmModel, String) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getConsentsStream instead.

getConsents(RealmModel, String) - Method in interface org.keycloak.models.UserProvider.Streams

getConsents(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

Deprecated.

Use getConsentsStream instead.

getConsents(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage.Streams

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.

getConsentsStream(RealmModel, String) - Method in interface org.keycloak.models.UserProvider.Streams

getConsentsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

Obtains the consents associated with the federated user identified by userId.

getConsentsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage.Streams

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, UrlType) - Method in interface org.keycloak.urls.HostnameProvider

Returns the context-path for Keycloak.

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.

getCount() - Method in class org.keycloak.models.ClientInitialAccessModel

getCounter() - Method in class org.keycloak.credential.CredentialModel

Deprecated.

Recommended to use OTPCredentialModel.getCredentialData().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

getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getCreatedTimestamp() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

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

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

getDefaultClientScopes(boolean) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getDefaultClientScopesStream instead.

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

getDefaultGroups() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getDefaultGroupsStream instead.

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

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

getDelegateForUpdate() - Method in interface org.keycloak.models.cache.CachedUserModel

Invalidates the cache for this user and returns a delegate that represents the actual data provider

getDescription() - Method in class org.keycloak.models.AuthenticationFlowModel

getDescription() - Method in interface org.keycloak.models.ClientModel

getDescription() - Method in interface org.keycloak.models.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.getCredentialData().getDevice()

getDevice() - Method in class org.keycloak.models.UserCredentialModel

getDigits() - Method in class org.keycloak.credential.CredentialModel

Deprecated.

Recommended to use OTPCredentialModel.getCredentialData().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

getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.credential.CredentialInputUpdater

Deprecated.

Use getDisableableCredentialTypesStream instead.

getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.credential.CredentialInputUpdater.Streams

getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager

Deprecated.

Use getDisableableCredentialTypesStream instead.

getDisableableCredentialTypes(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager.Streams

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.credential.CredentialInputUpdater.Streams

getDisableableCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager

Obtains the credential types that can be disabled by means of the UserCredentialManager.disableCredentialType(RealmModel, UserModel, String) method.

getDisableableCredentialTypesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserCredentialManager.Streams

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.

getEmail() - Method in interface org.keycloak.models.UserModel

getEmail() - Method in class org.keycloak.models.UserModelDefaultMethods

getEmail() - Method in class org.keycloak.models.utils.UserModelDelegate

getEmail() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getEmailTheme() - Method in interface org.keycloak.models.RealmModel

getEnabledEventTypes() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getEnabledEventTypesStream instead.

getEnabledEventTypesStream() - Method in interface org.keycloak.models.RealmModel

Returns enabled event types as a stream.

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

getEventsListeners() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getEventsListenersStream instead.

getEventsListenersStream() - Method in interface org.keycloak.models.RealmModel

Returns events listeners as a stream.

getEvictionDay() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getEvictionHour() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getEvictionMinute() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getExecutionStatus() - Method in interface org.keycloak.sessions.AuthenticationSessionModel

Returns execution status of the authentication session.

getExpiration() - Method in interface org.keycloak.models.ActionTokenKeyModel

Returns absolute number of seconds since the epoch in UTC timezone when the token expires.

getExpiration() - Method in class org.keycloak.models.ClientInitialAccessModel

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

getFederatedIdentities(UserModel, RealmModel) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getFederatedIdentitiesStream instead.

getFederatedIdentities(UserModel, RealmModel) - Method in interface org.keycloak.models.UserProvider.Streams

getFederatedIdentities(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

Deprecated.

Use getFederatedIdentitiesStream instead.

getFederatedIdentities(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage.Streams

getFederatedIdentitiesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserProvider

Obtains the federated identities of the specified user.

getFederatedIdentitiesStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserProvider.Streams

getFederatedIdentitiesStream(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

Obtains the identities of the federated user identified by userId.

getFederatedIdentitiesStream(String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage.Streams

getFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider

Returns details of the association between the user and the socialProvider.

getFederatedIdentity(UserModel, String, RealmModel) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getFederatedIdentity instead.

getFederatedIdentity(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserProvider.Streams

getFederatedIdentity(UserModel, String, RealmModel) - Method in interface org.keycloak.models.UserProvider.Streams

getFederatedIdentity(String, String, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

getFederatedRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFederatedStorage() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFederationLink() - Method in interface org.keycloak.models.UserModel

getFederationLink() - Method in class org.keycloak.models.utils.UserModelDelegate

getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

getFederationLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

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

getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getFirstAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getFirstBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel

getFirstName() - Method in interface org.keycloak.models.UserModel

getFirstName() - Method in class org.keycloak.models.UserModelDefaultMethods

getFirstName() - Method in class org.keycloak.models.utils.UserModelDelegate

getFirstName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getFlowByAlias(String) - Method in interface org.keycloak.models.RealmModel

getFlowId() - Method in class org.keycloak.models.AuthenticationExecutionModel

If this execution is a flow, this is the flowId pointing to an AuthenticationFlowModel

getFormLabel() - Method in class org.keycloak.models.RequiredCredentialModel

getFullSyncPeriod() - Method in class org.keycloak.storage.UserStorageProviderModel

getGrantedClientScopes() - Method in class org.keycloak.models.UserConsentModel

getGroup() - Method in interface org.keycloak.models.GroupModel.GroupRemovedEvent

getGroupById(String, RealmModel) - Method in interface org.keycloak.models.GroupProvider

Deprecated.

Use method getGroupById

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(String, RealmModel) - 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

getGroupMembers(RealmModel, GroupModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getGroupMembersStream instead.

getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getGroupMembersStream instead.

getGroupMembers(RealmModel, GroupModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getGroupMembers(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

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.

getGroupMembersStream(RealmModel, GroupModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getGroupMembersStream(RealmModel, GroupModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getGroups(RealmModel) - Method in interface org.keycloak.models.GroupProvider

Deprecated.

Use getGroupsStream instead.

getGroups() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getGroupsStream instead.

getGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

getGroups() - Method in interface org.keycloak.models.UserModel

Deprecated.

Use getGroupsStream instead.

getGroups(int, int) - Method in interface org.keycloak.models.UserModel

Deprecated.

Use getGroupsStream instead.

getGroups(String, int, int) - Method in interface org.keycloak.models.UserModel

Deprecated.

Use getGroupsStream instead.

getGroups() - Method in interface org.keycloak.models.UserModel.Streams

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets groups from federated storage and automatically appends default groups of realm.

getGroups() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getGroups(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Deprecated.

Use getGroupsStream instead.

getGroups(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.Streams

getGroupsByRole(RealmModel, RoleModel, int, int) - Method in interface org.keycloak.models.GroupProvider

Deprecated.

Use getGroupsByRoleStream instead.

getGroupsByRole(RealmModel, RoleModel, int, int) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

getGroupsByRoleStream(RealmModel, RoleModel, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider

Returns groups with the given role in the given realm.

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

getGroupsCount(RealmModel, Boolean) - Method in interface org.keycloak.models.GroupProvider

Returns a number of groups/top level groups (i.e.

getGroupsCount(Boolean) - Method in interface org.keycloak.models.RealmModel

getGroupsCount(RealmModel, Boolean) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

getGroupsCount() - Method in interface org.keycloak.models.UserModel

getGroupsCountByNameContaining(RealmModel, String) - Method in interface org.keycloak.models.GroupProvider

Returns number of groups with the given string in name for the given realm.

getGroupsCountByNameContaining(String) - Method in interface org.keycloak.models.RealmModel

getGroupsCountByNameContaining(RealmModel, String) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

getGroupsCountByNameContaining(String) - Method in interface org.keycloak.models.UserModel

getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

Get group membership mappings that are managed by this storage provider

getGroupsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Get group membership mappings that are managed by this storage provider

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>, 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.

getGroupsStream(RealmModel, Stream<String>, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider

Returns a paginated stream of groups with given ids.

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(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() - Method in interface org.keycloak.models.UserModel.Streams

getGroupsStream() - Method in class org.keycloak.models.utils.UserModelDelegate

getGroupsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getGroupsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getGroupsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Obtains the groups associated with the federated user.

getGroupsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.Streams

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.getCredentialData().getHashIterations()

getHashIterations() - Method in class org.keycloak.models.credential.dto.PasswordCredentialData

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

getHelpText() - Method in interface org.keycloak.storage.UserStorageProviderFactory

getHmacKeys(RealmModel) - Method in interface org.keycloak.models.KeyManager

Deprecated.

getHmacSecretKey(RealmModel, String) - Method in interface org.keycloak.models.KeyManager

Deprecated.

getHostname(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider

Returns the host.

getHostname(UriInfo) - 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.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.adapter.AbstractUserAdapter

Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()

getId() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()

getId() - Method in class org.keycloak.storage.StorageId

getId() - Method in interface org.keycloak.storage.UserStorageProviderFactory

This is the name of the provider and will be showed in the admin console as an option.

getIdentityProvider() - Method in class org.keycloak.models.FederatedIdentityModel

getIdentityProviderAlias() - Method in class org.keycloak.models.IdentityProviderMapperModel

getIdentityProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel

getIdentityProviderMapper() - Method in class org.keycloak.models.IdentityProviderMapperModel

getIdentityProviderMapperById(String) - Method in interface org.keycloak.models.RealmModel

getIdentityProviderMapperByName(String, String) - Method in interface org.keycloak.models.RealmModel

getIdentityProviderMappers() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getIdentityProviderMappersStream instead.

getIdentityProviderMappersByAlias(String) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getIdentityProviderMappersByAliasStream instead.

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.

getIdentityProviders() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getIdentityProvidersStream instead.

getIdentityProvidersStream() - Method in interface org.keycloak.models.RealmModel

Returns identity providers as a stream.

getImportName() - Method in interface org.keycloak.theme.Theme

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(RealmModel, String, KeyUse, String) - Method in interface org.keycloak.models.KeyManager

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.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.UserModel.UserRemovedEvent

getKeycloakSession() - Method in interface org.keycloak.models.UserSessionProvider

Returns currently used Keycloak session.

getKeycloakSessionFactory() - Method in interface org.keycloak.models.KeycloakSession

getKeys(RealmModel) - Method in interface org.keycloak.models.KeyManager

Deprecated.

Use getKeysStream instead.

getKeys(RealmModel, KeyUse, String) - Method in interface org.keycloak.models.KeyManager

Deprecated.

Use getKeysStream instead.

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.UserModelDefaultMethods

getLastName() - Method in class org.keycloak.models.utils.UserModelDelegate

getLastName() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getLastSessionRefresh() - Method in interface org.keycloak.models.UserSessionModel

getLastSync() - Method in class org.keycloak.storage.UserStorageProviderModel

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

getLifespan() - Method in class org.keycloak.storage.CacheableStorageProviderModel

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

getMaxLifespan() - Method in class org.keycloak.storage.CacheableStorageProviderModel

getMembership(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Deprecated.

Use getMembershipStream instead.

getMembership(RealmModel, GroupModel, int, int) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.Streams

getMembershipStream(RealmModel, GroupModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

Obtains the federated users that are members of the given group in the specified realm.

getMembershipStream(RealmModel, GroupModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.Streams

getMessage() - Method in class org.keycloak.policy.PolicyError

getMessages(Locale) - Method in interface org.keycloak.theme.Theme

Same as getMessages(baseBundlename, locale), but uses a default baseBundlename such as "messages".

getMessages(String, Locale) - Method in interface org.keycloak.theme.Theme

Retrieve localized messages from a message bundle.

getMessages(String, Locale) - Method in interface org.keycloak.theme.ThemeResourceProvider

Load the message bundle for the specific name and locale

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.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.OTPPolicy.FreeOTP

getName() - Method in class org.keycloak.models.OTPPolicy.GoogleAuthenticator

getName() - Method in interface org.keycloak.models.OTPPolicy.OtpApp

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.federated.UserFederatedStorageProviderSpi

getName() - Method in class org.keycloak.storage.SearchableModelField

getName() - Method in class org.keycloak.storage.UserStorageProviderSpi

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

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

getNotBeforeOfUser(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserNotBeforeFederatedStorage

getNote(String) - Method in class org.keycloak.component.ComponentModel

getNote(String) - Method in interface org.keycloak.models.ActionTokenValueModel

Returns value of the given note (or null when no note of this name is present)

getNote(String) - Method in interface org.keycloak.models.AuthenticatedClientSessionModel

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.ActionTokenValueModel

Returns unmodifiable map of all notes.

getNotes() - Method in interface org.keycloak.models.AuthenticatedClientSessionModel

getNotes() - Method in interface org.keycloak.models.UserSessionModel

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

getOfflineUserSessionByBrokerUserId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getOfflineUserSessionByBrokerUserIdStream instead.

getOfflineUserSessionByBrokerUserIdStream(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider

Obtains the offline user sessions associated with the user that matches the specified brokerUserId.

getOfflineUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getOfflineUserSessionsStream instead.

getOfflineUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

use getOfflineUserSessionsStream instead.

getOfflineUserSessionsStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider

Obtains the offline user sessions associated with the specified user.

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 most maxResults.

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 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.

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.getCredentialData().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, UrlType) - Method in interface org.keycloak.urls.HostnameProvider

Returns the port (or -1 for default port).

getPort(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider

Returns the port (or -1 for default port).

getPostBrokerLoginFlowId() - Method in class org.keycloak.models.IdentityProviderModel

getPriority() - Method in class org.keycloak.component.PrioritizedComponentModel

getPriority() - Method in class org.keycloak.models.AuthenticationExecutionModel

getPriority() - Method in class org.keycloak.models.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

getProtocolMappers() - Method in interface org.keycloak.models.ClientSessionContext

Deprecated.

Use getProtocolMappersStream instead.

getProtocolMappers() - Method in interface org.keycloak.models.ProtocolMapperContainerModel

Deprecated.

Use getProtocolMappersStream instead.

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(String) - Method in interface org.keycloak.models.KeycloakSession

getProviderClass() - Method in interface org.keycloak.provider.Spi

getProviderClass() - Method in class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

getProviderClass() - Method in class org.keycloak.storage.UserStorageProviderSpi

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

getProviderFactories(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory

Deprecated.

Use getProviderFactoriesStream instead.

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.storage.federated.UserFederatedStorageProviderSpi

getProviderFactoryClass() - Method in class org.keycloak.storage.UserStorageProviderSpi

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.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

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.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(String) - Method in interface org.keycloak.models.RealmProvider

Exact search for a realm by its internal ID.

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.

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.

getRealmRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel

Deprecated.

Use getRealmRoleMappingsStream instead.

getRealmRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel.Streams

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getRealmRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRealmRoleMappingsStream() - Method in interface org.keycloak.models.RoleMapperModel

Returns stream of realm roles that are directly set to this object.

getRealmRoleMappingsStream() - Method in interface org.keycloak.models.RoleMapperModel.Streams

getRealmRoleMappingsStream() - Method in class org.keycloak.models.utils.UserModelDelegate

getRealmRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRealmRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRealmRoles(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from RoleProvider.

getRealmRoles(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from RoleProvider.

getRealmRoles(RealmModel) - Method in interface org.keycloak.models.RoleProvider

Deprecated.

use the stream variant instead

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.

getRealms() - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use getRealmsStream instead.

getRealmScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel

Deprecated.

Use getRealmScopeMappingsStream instead.

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.

getRealmsWithProviderType(Class<?>) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use getRealmsWithProviderTypeStream instead.

getRealmsWithProviderTypeStream(Class<?>) - Method in interface org.keycloak.models.RealmProvider

Returns stream of realms which has component with the given provider type.

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

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

getRequiredActionProviderByAlias(String) - Method in interface org.keycloak.models.RealmModel

getRequiredActionProviderById(String) - Method in interface org.keycloak.models.RealmModel

getRequiredActionProviders() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getRequiredActionProvidersStream instead.

getRequiredActionProvidersStream() - Method in interface org.keycloak.models.RealmModel

Returns sorted RequiredActionProviderModel as a stream.

getRequiredActions() - Method in interface org.keycloak.models.UserModel

Deprecated.

Use getRequiredActionsStream instead.

getRequiredActions() - Method in interface org.keycloak.models.UserModel.Streams

getRequiredActions() - Method in interface org.keycloak.sessions.AuthenticationSessionModel

Returns required actions that are attached to this client session.

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

getRequiredActions() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRequiredActions(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

Deprecated.

Use getRequiredActionsStream instead.

getRequiredActions(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage.Streams

getRequiredActionsStream() - Method in interface org.keycloak.models.UserModel

Obtains the names of required actions associated with the user.

getRequiredActionsStream() - Method in interface org.keycloak.models.UserModel.Streams

getRequiredActionsStream() - Method in class org.keycloak.models.utils.UserModelDelegate

getRequiredActionsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRequiredActionsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRequiredActionsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

Obtains the names of required actions associated with the federated user identified by userId.

getRequiredActionsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage.Streams

getRequiredCredentials() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getRequiredCredentialsStream instead.

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(String) - Method in interface org.keycloak.models.RoleContainerModel

getRole() - Method in interface org.keycloak.models.RoleContainerModel.RoleRemovedEvent

getRoleById(String) - Method in interface org.keycloak.models.RealmModel

getRoleById(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider

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..

getRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel

Deprecated.

Use getRoleMappingsStream instead.

getRoleMappings() - Method in interface org.keycloak.models.RoleMapperModel.Streams

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Gets role mappings from federated storage and automatically appends default roles.

getRoleMappings() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRoleMappings(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

Deprecated.

Use getRoleMappingsStream instead.

getRoleMappings(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage.Streams

getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

getRoleMappingsInternal() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

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 interface org.keycloak.models.RoleMapperModel.Streams

getRoleMappingsStream() - Method in class org.keycloak.models.utils.UserModelDelegate

getRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

getRoleMappingsStream() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

getRoleMappingsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

Obtains the roles associated with the federated user identified by userId.

getRoleMappingsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage.Streams

getRoleMembers(RealmModel, RoleModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getRoleMembersStream instead.

getRoleMembers(RealmModel, RoleModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getRoleMembersStream instead.

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.

getRoles() - Method in interface org.keycloak.models.ClientSessionContext

Deprecated.

Use getRolesStream instead.

getRoles() - Method in interface org.keycloak.models.RoleContainerModel

Deprecated.

Use getRolesStream instead.

getRoles(Integer, Integer) - Method in interface org.keycloak.models.RoleContainerModel

Deprecated.

Use getRolesStream instead.

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.

getRoleStorageProviders() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getRoleStorageProvidersStream instead.

getRoleStorageProvidersStream() - Method in interface org.keycloak.models.RealmModel

Returns sorted RoleStorageProviderModel as a stream.

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.getSecretData().getSalt()

getSalt() - Method in class org.keycloak.models.credential.dto.PasswordSecretData

getScheme(UriInfo, UrlType) - Method in interface org.keycloak.urls.HostnameProvider

Returns the URL scheme.

getScheme(UriInfo) - Method in interface org.keycloak.urls.HostnameProvider

Returns the URL scheme.

getScopeMappings() - Method in interface org.keycloak.models.ScopeContainerModel

Deprecated.

Use getScopeMappingsStream instead.

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

getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

getServiceAccountClientLink() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

getSignatureAlgorithm() - Method in class org.keycloak.models.WebAuthnPolicy

getSmtpConfig() - Method in interface org.keycloak.models.RealmModel

getSpi(Class<? extends Provider>) - Method in interface org.keycloak.models.KeycloakSessionFactory

getSpis() - Method in interface org.keycloak.models.KeycloakSessionFactory

getSslRequired() - Method in interface org.keycloak.models.RealmModel

getSsoSessionIdleTimeout() - Method in interface org.keycloak.models.RealmModel

getSsoSessionIdleTimeoutRememberMe() - Method in interface org.keycloak.models.RealmModel

getSsoSessionMaxLifespan() - Method in interface org.keycloak.models.RealmModel

getSsoSessionMaxLifespanRememberMe() - Method in interface org.keycloak.models.RealmModel

getStarted() - Method in interface org.keycloak.models.UserSessionModel

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(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore

getStoredCredentialById(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

getStoredCredentialByNameAndType(RealmModel, UserModel, String, String) - Method in interface org.keycloak.credential.UserCredentialStore

getStoredCredentialByNameAndType(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

getStoredCredentials(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore

Deprecated.

Use getStoredCredentialsStream instead.

getStoredCredentials(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore.Streams

getStoredCredentials(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Deprecated.

Use getStoredCredentialsStream instead.

getStoredCredentials(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore.Streams

getStoredCredentialsByType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore

Deprecated.

Use getStoredCredentialsByTypeStream instead.

getStoredCredentialsByType(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore.Streams

getStoredCredentialsByType(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Deprecated.

Use getStoredCredentialsByTypeStream instead.

getStoredCredentialsByType(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore.Streams

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.

getStoredCredentialsByTypeStream(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.UserCredentialStore.Streams

getStoredCredentialsByTypeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Obtains the credentials of type type that are associated with the federated user identified by userId.

getStoredCredentialsByTypeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore.Streams

getStoredCredentialsStream(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore

Obtains the stored credentials associated with the specified user.

getStoredCredentialsStream(RealmModel, UserModel) - Method in interface org.keycloak.credential.UserCredentialStore.Streams

getStoredCredentialsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

Obtains the credentials associated with the federated user identified by userId.

getStoredCredentialsStream(RealmModel, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore.Streams

getStoredUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

Deprecated.

Use getStoredUsersStream instead.

getStoredUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider.Streams

getStoredUsersCount(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

getStoredUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

Obtains the ids of all federated users in the realm.

getStoredUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider.Streams

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.

getSubGroups() - Method in interface org.keycloak.models.GroupModel

Deprecated.

Use getSubGroupsStream instead.

getSubGroups() - Method in interface org.keycloak.models.GroupModel.Streams

getSubGroupsStream() - Method in interface org.keycloak.models.GroupModel

Returns all sub groups for the parent group as a stream.

getSubGroupsStream() - Method in interface org.keycloak.models.GroupModel.Streams

getSubType() - Method in class org.keycloak.component.ComponentModel

getSubType() - Method in class org.keycloak.models.credential.dto.OTPCredentialData

getSupportedApplications() - Method in class org.keycloak.models.OTPPolicy

getSupportedLocales() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getSupportedLocalesStream instead.

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(Theme.Type) - Method in interface org.keycloak.models.ThemeManager

Returns the theme for the specified type.

getTheme(String, Theme.Type) - Method in interface org.keycloak.models.ThemeManager

Returns the specified 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

getTopLevelGroups(RealmModel) - Method in interface org.keycloak.models.GroupProvider

Deprecated.

Use getTopLevelGroupsStream instead.

getTopLevelGroups(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.GroupProvider

Deprecated.

Use getTopLevelGroupsStream instead.

getTopLevelGroups() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getTopLevelGroups instead.

getTopLevelGroups(Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getTopLevelGroupsStream instead.

getTopLevelGroups(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

getTopLevelGroups(RealmModel, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

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.

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.

getTransactionManager() - Method in interface org.keycloak.models.KeycloakSession

getType() - Method in interface org.keycloak.credential.CredentialInput

getType() - Method in class org.keycloak.credential.CredentialModel

getType() - Method in 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.

getTypeMetadata() - Method in interface org.keycloak.storage.UserStorageProviderFactory

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.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.

getUserByEmail(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider

Returns a user with the given email belonging to the realm

getUserByEmail(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider

Deprecated.

Use getUserByEmail instead.

getUserByEmail(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserByEmail(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserByFederatedIdentity(RealmModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider

Returns a userModel that corresponds to the given socialLink.

getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getUserByFederatedIdentity instead.

getUserByFederatedIdentity(RealmModel, FederatedIdentityModel) - Method in interface org.keycloak.models.UserProvider.Streams

getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.models.UserProvider.Streams

getUserByFederatedIdentity(FederatedIdentityModel, RealmModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

getUserById(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider

Returns a user with the given id belonging to the realm

getUserById(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider

Deprecated.

Use getUserById instead.

getUserById(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserById(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserByUsername(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider

Returns a user with the given username belonging to the realm

getUserByUsername(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider

Deprecated.

Use getUserByUsername instead.

getUserByUsername(RealmModel, String) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserByUsername(String, RealmModel) - Method in interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserId() - Method in interface org.keycloak.models.ActionTokenKeyModel

getUserId() - Method in class org.keycloak.models.FederatedIdentityModel

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 class org.keycloak.models.FederatedIdentityModel

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

getUsers(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getUsersStream instead.

getUsers(RealmModel, int, int, boolean) - Method in interface org.keycloak.models.UserProvider

Deprecated.

Use getUsersStream instead.

getUsers(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider.Streams

getUsers(RealmModel, int, int, boolean) - Method in interface org.keycloak.models.UserProvider.Streams

getUsers(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersStream instead.

getUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersStream instead.

getUsers(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsers(RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersByUserAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

Deprecated.

Use getUsersByUserAttributeStream instead.

getUsersByUserAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage.Streams

getUsersByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

Searches for federated users that have an attribute with the specified name and value.

getUsersByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage.Streams

getUsersCount(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Returns the number of users, without consider any service account.

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.

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(String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersCount

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 the groupIds set.

getUsersCount(String, RealmModel, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersCount instead.

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(Map<String, String>, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersCount instead.

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(Map<String, String>, RealmModel, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use getUsersCount instead.

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.Streams

getUsersCount(String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(RealmModel, String, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(String, RealmModel, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(RealmModel, Map<String, String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(Map<String, String>, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(RealmModel, Map<String, String>, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersCount(Map<String, String>, RealmModel, Set<String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

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

getUserSessionByBrokerUserId(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getUserSessionByBrokerUserIdStream instead.

getUserSessionByBrokerUserIdStream(RealmModel, String) - Method in interface org.keycloak.models.UserSessionProvider

Obtains the online user sessions associated with the user that matches the specified brokerUserId.

getUserSessionId() - Method in class org.keycloak.models.SamlArtifactSessionMappingModel

getUserSessionNotes() - Method in interface org.keycloak.sessions.AuthenticationSessionModel

Retrieves value of given user session note.

getUserSessions(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getUserSessionsStream instead.

getUserSessions(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getUserSessionsStream instead.

getUserSessions(RealmModel, ClientModel, int, int) - Method in interface org.keycloak.models.UserSessionProvider

Deprecated.

Use getUserSessionsStream instead.

getUserSessionsStream(RealmModel, UserModel) - Method in interface org.keycloak.models.UserSessionProvider

Obtains the online user sessions associated with the specified user.

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 most maxResults.

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, boolean) - Method in interface org.keycloak.models.UserProvider

Obtains the users associated with the specified realm.

getUsersStream(RealmModel, Integer, Integer, boolean) - Method in interface org.keycloak.models.UserProvider

Obtains the users associated with the specified realm.

getUsersStream(RealmModel, boolean) - Method in interface org.keycloak.models.UserProvider.Streams

getUsersStream(RealmModel, Integer, Integer, boolean) - Method in interface org.keycloak.models.UserProvider.Streams

getUsersStream(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Searches all users in the realm.

getUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider

Searches all users in the realm, starting from the firstResult and containing at most maxResults.

getUsersStream(RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUsersStream(RealmModel, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

getUserStorageProviders() - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use getUserStorageProvidersStream instead.

getUserStorageProvidersStream() - Method in interface org.keycloak.models.RealmModel

Returns sorted UserStorageProviderModel as a stream.

getUserVerificationRequirement() - Method in class org.keycloak.models.WebAuthnPolicy

getValue() - Method in class org.keycloak.credential.CredentialModel

Deprecated.

Recommended to use PasswordCredentialModel.getSecretData().getValue() or OTPCredentialModel.getSecretData().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

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

GoogleAuthenticator() - Constructor for class org.keycloak.models.OTPPolicy.GoogleAuthenticator

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

grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

grantRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

grantRole(RealmModel, String, RoleModel) - Method in interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage

grantToAllUsers(RealmModel, RoleModel) - Method in interface org.keycloak.storage.user.UserBulkUpdateProvider

Grants the given role to all users from particular realm.

groupLocalStorage() - Method in interface org.keycloak.models.KeycloakSession

Keycloak specific local storage for groups.

GroupLookupProvider - Interface in org.keycloak.storage.group

GroupModel - 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

The GroupModel.Streams interface makes all collection-based methods in GroupModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

GroupStorageProvider - Interface in org.keycloak.storage.group

GroupStorageProviderModel - Class in org.keycloak.storage.group

Stored configuration of a Group Storage provider instance.

GroupStorageProviderModel() - Constructor for class org.keycloak.storage.group.GroupStorageProviderModel

GroupStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.group.GroupStorageProviderModel

GUI_ORDER - Static variable in interface org.keycloak.models.ClientScopeModel

H

HASH_ALGORITHM_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy

HASH_ALGORITHM_ID - Static variable in class org.keycloak.models.PasswordPolicy

HASH_ITERATIONS_DEFAULT - Static variable in class org.keycloak.models.PasswordPolicy

HASH_ITERATIONS_ID - Static variable in class org.keycloak.models.PasswordPolicy

hashCode() - Method in class org.keycloak.models.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.storage.adapter.AbstractUserAdapter

hashCode() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

hashCode() - Method in class org.keycloak.storage.SearchableModelField

hasNote(String) - Method in class org.keycloak.component.ComponentModel

hasRole(RoleModel) - Method in interface org.keycloak.models.RoleMapperModel

Returns true if this object is directly or indirectly assigned the given role, false otherwise.

hasRole(RoleModel) - Method in interface org.keycloak.models.RoleModel

hasRole(Set<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils

hasRole(Stream<RoleModel>, RoleModel) - Static method in class org.keycloak.models.utils.RoleUtils

hasRole(RoleModel) - Method in class org.keycloak.models.utils.UserModelDelegate

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

hasRole(RoleModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

hasRoleFromGroup(GroupModel, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils

Checks whether the targetRole is contained in the given group or its parents (if requested)

hasRoleFromGroup(Iterable<GroupModel>, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils

Deprecated.

Use RoleUtils.hasRoleFromGroup(Stream, RoleModel, boolean) hasRoleFromGroup(Stream, RoleModel, boolean)} instead.

hasRoleFromGroup(Stream<GroupModel>, RoleModel, boolean) - Static method in class org.keycloak.models.utils.RoleUtils

Checks whether the targetRole is contained in any of the groups or their parents (if requested)

hasScope(RoleModel) - Method in interface org.keycloak.models.ScopeContainerModel

helpText(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder

helpText - Variable in class org.keycloak.provider.ProviderConfigProperty

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 - 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.

hotp(String) - Static method in class org.keycloak.models.UserCredentialModel

I

iconCssClass(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder

ID - Static variable in class org.keycloak.models.AuthenticatedClientSessionModel.SearchableFields

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 - Variable in class org.keycloak.models.IdentityProviderMapperModel

id - Variable in class org.keycloak.models.ProtocolMapperModel

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.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

IMPORT_ENABLED - Static variable in class org.keycloak.storage.UserStorageProviderModel

importComponentModel(ComponentModel) - Method in interface org.keycloak.models.RealmModel

Adds component model.

ImportedUserValidation - Interface in org.keycloak.storage.user

This is an optional capability interface that is intended to be implemented by any UserStorageProvider that supports validating users.

ImportSynchronization - Interface in org.keycloak.storage.user

This is an optional capability interface that is intended to be implemented by any UserStorageProvider that supports syncing users to keycloak local storage.

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

init(Config.Scope) - Method in interface org.keycloak.provider.ProviderFactory

Only called once when the factory is first created.

init(Config.Scope) - Method in interface org.keycloak.storage.UserStorageProviderFactory

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_CONFIG_TYPE - Static variable in interface org.keycloak.policy.PasswordPolicyProvider

invalidate() - Method in interface org.keycloak.models.cache.CachedUserModel

Invalidate the cache for this model

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.

invalidate(InvalidationHandler.InvalidableObjectType, Object...) - Method in interface org.keycloak.provider.InvalidationHandler

Invalidates intermediate states of the given objects

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_COMPOSITE_ROLE - Static variable in class org.keycloak.models.RoleModel.SearchableFields

IS_OFFLINE - Static variable in class org.keycloak.models.AuthenticatedClientSessionModel.SearchableFields

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

isComposite() - Method in interface org.keycloak.models.RoleModel

isConditional() - Method in class org.keycloak.models.AuthenticationExecutionModel

isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.credential.CredentialInputValidator

isConfiguredFor(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager

Checks to see if user has credential type configured.

isConfiguredLocally(RealmModel, UserModel, String) - Method in interface org.keycloak.models.UserCredentialManager

Only loops through each CredentialProvider to see if credential type is configured for the user.

isConsentRequired() - Method in interface org.keycloak.models.ClientModel

isDefaultAction() - Method in class org.keycloak.models.RequiredActionProviderModel

isDirectAccessGrantsEnabled() - Method in interface org.keycloak.models.ClientModel

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

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

isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isEmailVerified() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isEnabled() - Method in class org.keycloak.models.AuthenticationExecutionModel

isEnabled() - Method in interface org.keycloak.models.ClientModel

isEnabled() - Method in class org.keycloak.models.IdentityProviderModel

isEnabled() - Method in interface org.keycloak.models.RealmModel

isEnabled() - Method in class org.keycloak.models.RequiredActionProviderModel

isEnabled() - Method in interface org.keycloak.models.UserModel

isEnabled() - Method in class org.keycloak.models.utils.UserModelDelegate

isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isEnabled() - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isEnabled() - Method in class org.keycloak.storage.CacheableStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.client.ClientStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.group.GroupStorageProviderModel

isEnabled() - Method in class org.keycloak.storage.role.RoleStorageProviderModel

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

isImportEnabled() - Method in class org.keycloak.storage.UserStorageProviderModel

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.storage.federated.UserFederatedStorageProviderSpi

isInternal() - Method in class org.keycloak.storage.UserStorageProviderSpi

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(UserModel) - Static 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

isLoginHint() - Method in class org.keycloak.models.IdentityProviderModel

isLoginWithEmailAllowed() - Method in interface org.keycloak.models.RealmModel

isMarkedForEviction() - Method in interface org.keycloak.models.cache.CachedUserModel

isMember(Set<GroupModel>, GroupModel) - Static method in class org.keycloak.models.utils.RoleUtils

Deprecated.

Use RoleUtils.isMember(Stream, GroupModel) isMember(Stream, GroupModel)} instead.

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

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

isMemberOf(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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.

isPermanentLockout() - Method in interface org.keycloak.models.RealmModel

isPublicClient() - Method in interface org.keycloak.models.ClientModel

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

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(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputValidator

Tests whether a credential is valid

isValid(RealmModel, UserModel, List<CredentialInput>) - Method in interface org.keycloak.models.UserCredentialManager

Validates list of credentials.

isValid(RealmModel, UserModel, CredentialInput...) - Method in interface org.keycloak.models.UserCredentialManager

Validates list of credentials.

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

joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

joinGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

joinGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

K

KC_LOCALE_PARAM - Static variable in interface org.keycloak.locale.LocaleSelectorProvider

KERBEROS - Static variable in class org.keycloak.credential.CredentialModel

KERBEROS - Static variable in class org.keycloak.models.RequiredCredentialModel

KERBEROS - Static variable in class org.keycloak.models.UserCredentialModel

kerberos(String) - Static method in class org.keycloak.models.UserCredentialModel

KeycloakContext - Interface in org.keycloak.models

keycloakId(ComponentModel, String) - Static method in class org.keycloak.storage.StorageId

generate the id string that should be returned by UserModel.getId()

KeycloakSession - Interface in org.keycloak.models

KeycloakSessionFactory - Interface in org.keycloak.models

KeycloakSessionTask - Interface in org.keycloak.models

Task to be executed inside transaction

KeycloakTransaction - Interface in org.keycloak.models

KeycloakTransactionManager - Interface in org.keycloak.models

KeycloakTransactionManager.JTAPolicy - Enum in org.keycloak.models

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_NAME_ATTRIBUTE - Static variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

LAST_SESSION_REFRESH - Static variable in class org.keycloak.models.UserSessionModel.SearchableFields

LAST_SYNC - Static variable in class org.keycloak.storage.UserStorageProviderModel

leaveGroup(GroupModel) - Method in interface org.keycloak.models.UserModel

leaveGroup(GroupModel) - Method in class org.keycloak.models.utils.UserModelDelegate

leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

leaveGroup(GroupModel) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

leaveGroup(RealmModel, String, GroupModel) - Method in interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage

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)

listClientInitialAccess(RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use listClientInitialAccessStream instead.

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

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

LOGIN_HINT - Static variable in class org.keycloak.models.IdentityProviderModel

loginFailures() - Method in interface org.keycloak.models.KeycloakSession

Returns a managed provider instance.

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

mapAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

MAX_LIFESPAN - Static variable in class org.keycloak.storage.CacheableStorageProviderModel

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

moveCredentialTo(RealmModel, UserModel, String, String) - Method in interface org.keycloak.credential.UserCredentialStore

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(GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmModel

moveGroup(RealmModel, GroupModel, GroupModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

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 - Static variable in class org.keycloak.models.ClientScopeModel.SearchableFields

NAME - Static variable in class org.keycloak.models.GroupModel.SearchableFields

name - Variable in class org.keycloak.models.IdentityProviderMapperModel

name - Variable in class org.keycloak.models.ProtocolMapperModel

NAME - Static variable in class org.keycloak.models.RealmModel.SearchableFields

NAME - Static variable in class org.keycloak.models.RoleModel.SearchableFields

name - Variable in class org.keycloak.provider.ProviderConfigProperty

name(String) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

nameSet(Theme.Type) - Method in interface org.keycloak.models.ThemeManager

Returns a set of all theme names for the specified type.

notes - Variable in class org.keycloak.models.UserCredentialModel

numberDigits - Variable in class org.keycloak.models.utils.HmacOTP

O

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

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

onCache(RealmModel, CachedUserModel, UserModel) - Method in interface org.keycloak.models.cache.OnUserCache

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

onCreate(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

Called when UserStorageProviderModel is created.

onEvent(ProviderEvent) - Method in interface org.keycloak.provider.ProviderEventListener

onRealmRemoved(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider

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.

OnUserCache - Interface in org.keycloak.models.cache

options - Variable in class org.keycloak.provider.ProviderConfigProperty

options(String...) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

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.cache - package org.keycloak.models.cache

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.services.clientpolicy - package org.keycloak.services.clientpolicy

org.keycloak.sessions - package org.keycloak.sessions

org.keycloak.storage - package org.keycloak.storage

org.keycloak.storage.adapter - package org.keycloak.storage.adapter

org.keycloak.storage.client - package org.keycloak.storage.client

org.keycloak.storage.clientscope - package org.keycloak.storage.clientscope

org.keycloak.storage.federated - package org.keycloak.storage.federated

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 - Static variable in class org.keycloak.credential.CredentialModel

Deprecated.

otp(String, String) - Static method in class org.keycloak.models.UserCredentialModel

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.FreeOTP - Class in org.keycloak.models

OTPPolicy.GoogleAuthenticator - Class in org.keycloak.models

OTPPolicy.OtpApp - Interface in org.keycloak.models

OTPSecretData - Class in org.keycloak.models.credential.dto

OTPSecretData(String) - Constructor for class org.keycloak.models.credential.dto.OTPSecretData

P

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

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(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.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

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, 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)

PasswordSecretData(String, byte[]) - Constructor for class org.keycloak.models.credential.dto.PasswordSecretData

Default creator (Secret consists only of a value and a single salt)

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.

patchRealmLocalizationTexts(String, Map<String, String>) - Method in interface org.keycloak.models.RealmModel

Patches the realm-specific localization texts.

period - Variable in class org.keycloak.models.OTPPolicy

policyCheck(PasswordPolicy, PasswordCredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider

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)

PolicyError - Class in org.keycloak.policy

PolicyError(String, Object...) - Constructor for class org.keycloak.policy.PolicyError

postInit(KeycloakSessionFactory) - Method in interface org.keycloak.provider.ProviderFactory

Called after all provider factories have been initialized

postInit(KeycloakSessionFactory) - Method in interface org.keycloak.storage.UserStorageProviderFactory

postInit(KeycloakSessionFactory) - Method in interface org.keycloak.urls.HostnameProviderFactory

preRemove(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory

Called before the component is removed.

preRemove(RealmModel) - Method in interface org.keycloak.models.UserProvider

Called when a realm 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.

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.models.UserProvider

Called when a group is removed.

preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.models.UserProvider

Called when a client is removed.

preRemove(ProtocolMapperModel) - Method in interface org.keycloak.models.UserProvider

Called when a protocolMapper is removed

preRemove(ClientScopeModel) - Method in interface org.keycloak.models.UserProvider

Called when a client scope is removed.

preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.models.UserProvider

Called when a component is removed.

preRemove(RealmModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a realm is removed.

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a group is removed.

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.client.ClientStorageProvider

Callback when a role is removed.

preRemove(RealmModel, IdentityProviderModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

preRemove(RealmModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, ClientModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(ProtocolMapperModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(ClientScopeModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, UserModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel, ComponentModel) - Method in interface org.keycloak.storage.federated.UserFederatedStorageProvider

preRemove(RealmModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a realm is removed.

preRemove(RealmModel, GroupModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a group is removed.

preRemove(RealmModel, RoleModel) - Method in interface org.keycloak.storage.UserStorageProvider

Callback when a role is removed.

PrioritizedComponentModel - Class in org.keycloak.component

PrioritizedComponentModel(ComponentModel) - Constructor for class org.keycloak.component.PrioritizedComponentModel

PrioritizedComponentModel() - 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(ProviderConfigProperty) - Method in class org.keycloak.provider.ProviderConfigurationBuilder

property(String, String, String, String, Object, List<String>, boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder

property(String, String, String, String, Object, List<String>) - Method in class org.keycloak.provider.ProviderConfigurationBuilder

protocol - Variable in class org.keycloak.models.ProtocolMapperModel

protocolMapper - Variable in class org.keycloak.models.ProtocolMapperModel

ProtocolMapperContainerModel - Interface in org.keycloak.models

ProtocolMapperModel - Class in org.keycloak.models

Specifies a mapping from user data to a protocol claim assertion.

ProtocolMapperModel() - Constructor for class org.keycloak.models.ProtocolMapperModel

Provider - Interface in org.keycloak.provider

ProviderConfigProperty - Class in org.keycloak.provider

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, String...) - Constructor for class org.keycloak.provider.ProviderConfigProperty

ProviderConfigProperty(String, String, String, String, Object, boolean) - Constructor for class org.keycloak.provider.ProviderConfigProperty

ProviderConfigPropertyBuilder() - Constructor for class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

ProviderConfigurationBuilder - Class in org.keycloak.provider

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

put(String, String) - Method in class org.keycloak.component.ComponentModel

put(String, int) - Method in class org.keycloak.component.ComponentModel

put(String, long) - Method in class org.keycloak.component.ComponentModel

put(String, boolean) - Method in class org.keycloak.component.ComponentModel

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.storage.adapter.AbstractUserAdapter

realm - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

REALM_ID - Static variable in class org.keycloak.models.AuthenticatedClientSessionModel.SearchableFields

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

realmLocalStorage() - Method in interface org.keycloak.models.KeycloakSession

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.

register(ProviderEventListener) - Method in interface org.keycloak.provider.ProviderEventManager

registerNode(String, int) - Method in interface org.keycloak.models.ClientModel

Register node or just update the 'lastReRegistration' time if this node is already registered

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

Remove expired authentication sessions in all the realms

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

removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeAttribute(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeAttribute(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

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, RealmModel) - Method in interface org.keycloak.models.ClientProvider

Deprecated.

Use ClientProvider.removeClient(RealmModel, String) instead.

removeClient(RealmModel, String) - Method in interface org.keycloak.models.ClientProvider

Removes given client from the given realm.

removeClient(String) - Method in interface org.keycloak.models.RealmModel

removeClient(String, RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

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(ClientScopeModel) - Method in interface org.keycloak.models.ClientModel

removeClientScope(RealmModel, ClientModel, ClientScopeModel) - Method in interface org.keycloak.models.ClientProvider

Unassign clientScope from the client.

removeClientScope(RealmModel, String) - Method in interface org.keycloak.models.ClientScopeProvider

Removes client scope from the given realm.

removeClientScope(String) - Method in interface org.keycloak.models.RealmModel

Removes client scope with given id from this realm.

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

Removes all expired root authentication sessions for the given realm.

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

removeFederatedIdentity(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

removeGroup(RealmModel, GroupModel) - Method in interface org.keycloak.models.GroupProvider

Removes the given group for the given realm.

removeGroup(GroupModel) - Method in interface org.keycloak.models.RealmModel

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.

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

removeRedirectUri(String) - Method in interface org.keycloak.models.ClientModel

removeRequiredAction(String) - Method in interface org.keycloak.models.UserModel

removeRequiredAction(UserModel.RequiredAction) - Method in interface org.keycloak.models.UserModel

removeRequiredAction(String) - Method in class org.keycloak.models.utils.UserModelDelegate

removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.models.utils.UserModelDelegate

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.sessions.AuthenticationSessionModel

Removes a required action from the authentication session.

removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

removeRequiredAction(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeRequiredAction(UserModel.RequiredAction) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

removeRequiredAction(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage

removeRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel

removeRole(RealmModel, RoleModel) - Method in interface org.keycloak.models.RealmProvider

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(RealmModel) - Method in interface org.keycloak.models.RoleProvider

Removes all roles from the given realm.

removeRoles(ClientModel) - Method in interface org.keycloak.models.RoleProvider

Removes all roles from the given client.

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

removeStoredCredential(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

removeUser(RealmModel, UserModel) - Method in class org.keycloak.models.UserManager

removeUser(RealmModel, UserModel, UserProvider) - Method in class org.keycloak.models.UserManager

removeUser(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.UserRegistrationProvider

Called if user originated from this provider.

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, UserModel) - Method in interface org.keycloak.models.UserSessionProvider

removeUserSessions(RealmModel) - Method in interface org.keycloak.models.UserSessionProvider

removeWebOrigin(String) - Method in interface org.keycloak.models.ClientModel

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

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(UserModel) - Static method in class org.keycloak.storage.StorageId

resolveProviderId(ClientModel) - Static method in class org.keycloak.storage.StorageId

restartSession(RealmModel, UserModel, String, String, String, boolean, String, String) - Method in interface org.keycloak.models.UserSessionModel

restartSession(RealmModel) - Method in interface org.keycloak.sessions.RootAuthenticationSessionModel

Will completely restart whole state of authentication session.

revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.models.UserProvider

Remove a user consent given by the user id and client id

revokeConsentForClient(RealmModel, String, String) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

ROLE_TYPE - Static variable in class org.keycloak.provider.ProviderConfigProperty

RoleContainerModel - Interface in org.keycloak.models

RoleContainerModel.RoleRemovedEvent - Interface in org.keycloak.models

roleLocalStorage() - Method in interface org.keycloak.models.KeycloakSession

Keycloak specific local storage for roles.

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

The RoleMapperModel.Streams interface makes all collection-based methods in RoleMapperModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

RoleModel - 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

RoleStorageProvider - Interface in org.keycloak.storage.role

Base interface for components that want to provide an alternative storage mechanism for roles

RoleStorageProviderModel - Class in org.keycloak.storage.role

Stored configuration of a Role Storage provider instance.

RoleStorageProviderModel() - Constructor for class org.keycloak.storage.role.RoleStorageProviderModel

RoleStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.role.RoleStorageProviderModel

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

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

S

SamlArtifactSessionMappingModel - Class in org.keycloak.models

SamlArtifactSessionMappingModel(String, String) - Constructor for class org.keycloak.models.SamlArtifactSessionMappingModel

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_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.AuthenticatedClientSessionModel.SearchableFields

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.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

searchClientByClientId(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use searchClientByClientId instead.

searchClientByClientIdStream(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Search for clients by provided client's id.

searchClientsByClientId(String, Integer, Integer, RealmModel) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from ClientProvider.

searchClientsByClientId(String, Integer, Integer, RealmModel) - Method in interface org.keycloak.storage.client.ClientLookupProvider

Deprecated.

Use ClientLookupProvider.searchClientsByClientIdStream(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.

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.

searchForGroupByName(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Deprecated.

Use searchForGroupByName instead.

searchForGroupByName(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from GroupProvider.

searchForGroupByName(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.group.GroupLookupProvider

Deprecated.

Use searchForGroupByNameStream instead.

searchForGroupByNameStream(String, Integer, Integer) - Method in interface org.keycloak.models.RealmModel

Searches for groups by provided name.

searchForGroupByNameStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.group.GroupLookupProvider

Returns groups with the given string in name for the given realm.

searchForRoles(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.models.RealmProvider

Deprecated.

Use the corresponding method from RoleProvider.

searchForRoles(String, Integer, Integer) - Method in interface org.keycloak.models.RoleContainerModel

Deprecated.

Use searchForRolesStream instead.

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.

searchForUser(String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use searchForUserStream instead.

searchForUser(String, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use searchForUserStream instead.

searchForUser(Map<String, String>, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use searchForUserStream instead.

searchForUser(Map<String, String>, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use searchForUserStream instead.

searchForUser(String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUser(String, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUser(Map<String, String>, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUser(Map<String, String>, RealmModel, int, int) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUserByUserAttribute(String, String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider

Deprecated.

Use searchForUserByUserAttributeStream instead.

searchForUserByUserAttribute(String, String, RealmModel) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUserByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.user.UserQueryProvider

Searches for users that have a specific attribute with a specific value.

searchForUserByUserAttributeStream(RealmModel, String, String) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

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.

searchForUserStream(RealmModel, String) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUserStream(RealmModel, String, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUserStream(RealmModel, Map<String, String>) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

searchForUserStream(RealmModel, Map<String, String>, Integer, Integer) - Method in interface org.keycloak.storage.user.UserQueryProvider.Streams

SECRET - Static variable in class org.keycloak.credential.CredentialModel

secret - Variable in class org.keycloak.models.RequiredCredentialModel

SECRET - Static variable in class org.keycloak.models.RequiredCredentialModel

SECRET - Static variable in class org.keycloak.models.UserCredentialModel

secret(String) - Static method in class org.keycloak.models.UserCredentialModel

secret - Variable in class org.keycloak.provider.ProviderConfigProperty

secret(boolean) - Method in class org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

If turned on, this property is only writable and never readable.

SecretKeyMetadata - Class in org.keycloak.keys

SecretKeyMetadata() - Constructor for class org.keycloak.keys.SecretKeyMetadata

serializeKey() - Method in interface org.keycloak.models.ActionTokenKeyModel

SERVICE_ACCOUNT_CLIENT - Static variable in class org.keycloak.models.UserModel.SearchableFields

ID of the client corresponding to the service account

session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

session - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

sessions() - Method in interface org.keycloak.models.KeycloakSession

Returns a managed provider instance.

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.

See CredentialModel.getAlgorithm()

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, String) - Method in interface org.keycloak.models.ClientModel

setAttribute(String, String) - Method in interface org.keycloak.models.ClientScopeModel

setAttribute(String, Object) - Method in interface org.keycloak.models.ClientSessionContext

setAttribute(String, List<String>) - Method in interface org.keycloak.models.GroupModel

setAttribute(String, Object) - Method in interface org.keycloak.models.KeycloakSession

setAttribute(String, String) - Method in interface org.keycloak.models.RealmModel

setAttribute(String, Boolean) - Method in interface org.keycloak.models.RealmModel

setAttribute(String, Integer) - Method in interface org.keycloak.models.RealmModel

setAttribute(String, Long) - Method in interface org.keycloak.models.RealmModel

setAttribute(String, List<String>) - Method in interface org.keycloak.models.RoleModel

setAttribute(String, List<String>) - Method in interface org.keycloak.models.UserModel

setAttribute(String, List<String>) - Method in class org.keycloak.models.utils.UserModelDelegate

setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setAttribute(String, List<String>) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setAttribute(RealmModel, String, String, List<String>) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

setAuthenticateByDefault(boolean) - Method in class org.keycloak.models.IdentityProviderModel

Deprecated.

setAuthenticatedUser(UserModel) - Method in interface org.keycloak.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.

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

setCacheInvalidBefore(long) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setCachePolicy(CacheableStorageProviderModel.CachePolicy) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setCertificate(Certificate) - Method in class org.keycloak.keys.RsaKeyMetadata

setChangedSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel

setClient(ClientModel) - Method in interface org.keycloak.models.KeycloakContext

setClientAuthenticationFlow(AuthenticationFlowModel) - Method in interface org.keycloak.models.RealmModel

setClientAuthenticatorType(String) - Method in interface org.keycloak.models.ClientModel

setClientId(String) - Method in interface org.keycloak.models.ClientModel

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

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

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

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

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.

See CredentialModel.getCounter()

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

setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setCreatedTimestamp(Long) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setCreateTimeout(int) - Method in class org.keycloak.models.WebAuthnPolicy

setCredentialData(String) - Method in class org.keycloak.credential.CredentialModel

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.

See CredentialModel.getDevice()

setDevice(String) - Method in class org.keycloak.models.UserCredentialModel

setDigits(int) - Method in class org.keycloak.credential.CredentialModel

Deprecated.

See CredentialModel.setDigits(int)

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.UserModelDefaultMethods

setEmail(String) - Method in class org.keycloak.models.utils.UserModelDelegate

setEmail(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

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

setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setEmailVerified(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Stores as attribute in federated storage.

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

setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setEnabled(boolean) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setEnabled(boolean) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.client.ClientStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.group.GroupStorageProviderModel

setEnabled(boolean) - Method in class org.keycloak.storage.role.RoleStorageProviderModel

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

setEvictionDay(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEvictionHour(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

setEvictionMinute(int) - Method in class org.keycloak.storage.CacheableStorageProviderModel

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(String) - Method in class org.keycloak.models.CibaConfig

setExpiresIn(Integer) - 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

setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

setFederationLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

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.UserModelDefaultMethods

setFirstName(String) - Method in class org.keycloak.models.utils.UserModelDelegate

setFirstName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

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

setFullSyncPeriod(int) - Method in class org.keycloak.storage.UserStorageProviderModel

setGuiOrder(String) - Method in interface org.keycloak.models.ClientScopeModel

setHashIterations(int) - Method in class org.keycloak.credential.CredentialModel

Deprecated.

See CredentialModel.getHashIterations()

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

setImportEnabled(boolean) - Method in class org.keycloak.storage.UserStorageProviderModel

setIncludeInTokenScope(boolean) - Method in interface org.keycloak.models.ClientScopeModel

setInitialCounter(int) - Method in class org.keycloak.models.OTPPolicy

setInput(boolean) - Method in class org.keycloak.models.RequiredCredentialModel

setInternalId(String) - Method in class org.keycloak.models.IdentityProviderModel

setInternationalizationEnabled(boolean) - Method in interface org.keycloak.models.RealmModel

setJTAPolicy(KeycloakTransactionManager.JTAPolicy) - Method in interface org.keycloak.models.KeycloakTransactionManager

setKid(String) - Method in class org.keycloak.keys.KeyMetadata

setLabel(String) - Method in class org.keycloak.provider.ProviderConfigProperty

setLastFailure(long) - Method in interface org.keycloak.models.UserLoginFailureModel

setLastIPFailure(String) - Method in interface org.keycloak.models.UserLoginFailureModel

setLastName(String) - Method in interface org.keycloak.models.UserModel

setLastName(String) - Method in class org.keycloak.models.UserModelDefaultMethods

setLastName(String) - Method in class org.keycloak.models.utils.UserModelDelegate

setLastName(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setLastSessionRefresh(int) - Method in interface org.keycloak.models.UserSessionModel

setLastSync(int) - Method in class org.keycloak.storage.UserStorageProviderModel

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

setMaxLifespan(long) - Method in class org.keycloak.storage.CacheableStorageProviderModel

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

setNotBeforeForUser(RealmModel, String, int) - Method in interface org.keycloak.storage.federated.UserNotBeforeFederatedStorage

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

setPasswordPolicy(PasswordPolicy) - Method in interface org.keycloak.models.RealmModel

setPeriod(int) - Method in class org.keycloak.credential.CredentialModel

Deprecated.

See CredentialModel.setPeriod(int)

setPeriod(int) - Method in class org.keycloak.models.OTPPolicy

setPermanentLockout(boolean) - Method in interface org.keycloak.models.RealmModel

setPoolingInterval(String) - Method in class org.keycloak.models.CibaConfig

setPoolingInterval(Integer) - 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

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

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

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.

See CredentialModel.getSalt()

setSecret(String) - Method in interface org.keycloak.models.ClientModel

setSecret(boolean) - Method in class org.keycloak.models.RequiredCredentialModel

setSecret(boolean) - Method in class org.keycloak.provider.ProviderConfigProperty

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

setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

This method should not be overriden

setServiceAccountClientLink(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

This method should not be overriden

setServiceAccountsEnabled(boolean) - Method in interface org.keycloak.models.ClientModel

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

setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

setSingleAttribute(String, String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

setSingleAttribute(RealmModel, String, String, String) - Method in interface org.keycloak.storage.federated.UserAttributeFederatedStorage

setSmtpConfig(Map<String, String>) - Method in interface org.keycloak.models.RealmModel

setSslRequired(SslRequired) - Method in interface org.keycloak.models.RealmModel

setSsoSessionIdleTimeout(int) - Method in interface org.keycloak.models.RealmModel

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

setTrustEmail(boolean) - Method in class org.keycloak.models.IdentityProviderModel

setType(String) - Method in class org.keycloak.credential.CredentialModel

setType(ClaimTypeModel.ValueType) - Method in class org.keycloak.models.ClaimTypeModel

setType(String) - Method in class org.keycloak.models.OTPPolicy

setType(String) - Method in class org.keycloak.models.RequiredCredentialModel

setType(String) - Method in class org.keycloak.models.UserCredentialModel

setType(String) - Method in class org.keycloak.provider.ProviderConfigProperty

setupClientPoliciesOnCreatedRealm(RealmModel) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

when creating a realm, reads the builtin client profiles and policies that have already been set on keycloak application on booting keycloak and put them onto the realm as its attribute.

setupClientPoliciesOnExportingRealm(RealmModel, RealmRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

when exporting realm the realm, prepares the exported representation of the client profiles and policies.

setupClientPoliciesOnImportedRealm(RealmModel, RealmRepresentation) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

when importing a realm, reads the builtin client profiles and policies that have already been set on keycloak application on booting keycloak and override them with ones loaded from the imported realm json file.

setupClientPoliciesOnKeycloakApp(String, String) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

when booting keycloak, reads json representations of the builtin client profiles and policies from files enclosed in keycloak-services jar file and put them onto the keycloak application.

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

setUsername(String) - Method in class org.keycloak.storage.adapter.AbstractUserAdapter

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.

See CredentialModel.getValue()

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

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

shouldInvalidate(CachedObject) - Method in class org.keycloak.storage.CacheableStorageProviderModel

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

Spi - Interface in org.keycloak.provider

state - Variable in class org.keycloak.models.AbstractKeycloakTransaction

storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

storageId - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

StorageId - Class in org.keycloak.storage

StorageId(String) - Constructor for class org.keycloak.storage.StorageId

StorageId(String, String) - Constructor for class org.keycloak.storage.StorageId

storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapter

storageProviderModel - Variable in class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage

Streams() - Constructor for class org.keycloak.models.UserModelDefaultMethods.Streams

Streams(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapter.Streams

Streams(KeycloakSession, RealmModel, ComponentModel) - Constructor for class org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.Streams

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

supports(OTPPolicy) - Method in class org.keycloak.models.OTPPolicy.FreeOTP

supports(OTPPolicy) - Method in class org.keycloak.models.OTPPolicy.GoogleAuthenticator

supports(OTPPolicy) - Method in interface org.keycloak.models.OTPPolicy.OtpApp

supportsCredentialAuthenticationFor(String) - Method in interface org.keycloak.credential.CredentialAuthentication

supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputUpdater

supportsCredentialType(String) - Method in interface org.keycloak.credential.CredentialInputValidator

sync(KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization

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

syncSince(Date, KeycloakSessionFactory, String, UserStorageProviderModel) - Method in interface org.keycloak.storage.user.ImportSynchronization

T

TEXT_JAVASCRIPT - Static variable in interface org.keycloak.models.ScriptModel

MIME-Type for JavaScript

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

TIMESTAMP - Static variable in class org.keycloak.models.AuthenticatedClientSessionModel.SearchableFields

TIMESTAMP - Static variable in class org.keycloak.sessions.RootAuthenticationSessionModel.SearchableFields

toBuilder() - Method in class org.keycloak.models.PasswordPolicy

TokenManager - Interface in org.keycloak.models

tokens() - Method in interface org.keycloak.models.KeycloakSession

Token manager

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.models.UserModelDefaultMethods

toString() - Method in class org.keycloak.storage.SearchableModelField

toString() - Method in class org.keycloak.storage.user.SynchronizationResult

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.

totp(String) - Static method in class org.keycloak.models.UserCredentialModel

triggerOnEvent(ClientPolicyContext) - Method in interface org.keycloak.services.clientpolicy.ClientPolicyManager

execute a method for handling an event defined in ClientPolicyEvent.

type(String) - Method in class org.keycloak.credential.CredentialTypeMetadata.CredentialTypeMetadataBuilder

TYPE - Static variable in class org.keycloak.models.credential.OTPCredentialModel

TYPE - Static variable in class org.keycloak.models.credential.PasswordCredentialModel

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.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

Property type.

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

unregisterNode(String) - Method in interface org.keycloak.models.ClientModel

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, String) - 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, String) - 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

updateConsent(RealmModel, String, UserConsentModel) - Method in interface org.keycloak.storage.federated.UserConsentFederatedStorage

updateCounter(int) - Method in class org.keycloak.models.credential.OTPCredentialModel

updateCounter(long) - Method in class org.keycloak.models.credential.WebAuthnCredentialModel

updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.credential.CredentialInputUpdater

updateCredential(RealmModel, UserModel, CredentialModel) - Method in interface org.keycloak.credential.UserCredentialStore

updateCredential(RealmModel, UserModel, CredentialInput) - Method in interface org.keycloak.models.UserCredentialManager

Updates a credential.

updateCredential(RealmModel, String, CredentialModel) - Method in interface org.keycloak.storage.federated.UserFederatedUserCredentialStore

updateCredentialLabel(RealmModel, UserModel, String, String) - Method in interface org.keycloak.models.UserCredentialManager

Updates the credential label and invalidates the cache for the user.

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

updateFederatedIdentity(RealmModel, String, FederatedIdentityModel) - Method in interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage

updateIdentityProvider(IdentityProviderModel) - Method in interface org.keycloak.models.RealmModel

updateIdentityProviderMapper(IdentityProviderMapperModel) - Method in interface org.keycloak.models.RealmModel

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

updateRequiredActionProvider(RequiredActionProviderModel) - Method in interface org.keycloak.models.RealmModel

updateRequiredCredentials(Set<String>) - Method in interface org.keycloak.models.RealmModel

updateUsersLocale(UserModel, String) - Method in interface org.keycloak.locale.LocaleUpdaterProvider

UrlType - Enum in org.keycloak.urls

user(UserModel) - Method in class org.keycloak.credential.CredentialTypeMetadataContext.CredentialTypeMetadataContextBuilder

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

USER_SESSION_ID - Static variable in class org.keycloak.models.AuthenticatedClientSessionModel.SearchableFields

UserAttributeFederatedStorage - Interface in org.keycloak.storage.federated

UserAttributeFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserAttributeFederatedStorage.Streams interface makes all collection-based methods in UserAttributeFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserBrokerLinkFederatedStorage - Interface in org.keycloak.storage.federated

UserBrokerLinkFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserBrokerLinkFederatedStorage.Streams interface makes all collection-based methods in UserBrokerLinkFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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 - Interface in org.keycloak.models.cache

All these methods effect an entire cluster of Keycloak instances.

userCache() - Method in interface org.keycloak.models.KeycloakSession

The user cache

UserCache.Streams - Interface in org.keycloak.models.cache

The UserCache.Streams interface differs from UserCache in that it extends the UserProvider.Streams interface, allowing implementations of UserCache to focus on the Stream-based methods in the UserProvider interface.

UserConsentFederatedStorage - Interface in org.keycloak.storage.federated

UserConsentFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserConsentFederatedStorage.Streams interface makes all collection-based methods in UserConsentFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserConsentModel - Class in org.keycloak.models

UserConsentModel(ClientModel) - Constructor for class org.keycloak.models.UserConsentModel

userCredentialManager() - Method in interface org.keycloak.models.KeycloakSession

Service that allows you to valid and update credentials for a user

UserCredentialManager - Interface in org.keycloak.models

UserCredentialManager.Streams - Interface in org.keycloak.models

The UserCredentialManager.Streams interface makes all collection-based methods in UserCredentialManager default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

The UserCredentialStore.Streams interface makes all collection-based methods in UserCredentialStore default by providing implementations that delegate to the Stream-based variants instead of the other way around.

userFederatedStorage() - Method in interface org.keycloak.models.KeycloakSession

Hybrid storage for UserStorageProviders that can't store a specific piece of keycloak data in their external storage.

UserFederatedStorageProvider - Interface in org.keycloak.storage.federated

UserFederatedStorageProvider.Streams - Interface in org.keycloak.storage.federated

The UserFederatedStorageProvider.Streams interface makes all collection-based methods in UserFederatedStorageProvider default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserFederatedStorageProviderFactory - Interface in org.keycloak.storage.federated

UserFederatedStorageProviderSpi - Class in org.keycloak.storage.federated

UserFederatedStorageProviderSpi() - Constructor for class org.keycloak.storage.federated.UserFederatedStorageProviderSpi

UserFederatedUserCredentialStore - Interface in org.keycloak.storage.federated

UserFederatedUserCredentialStore.Streams - Interface in org.keycloak.storage.federated

The UserFederatedUserCredentialStore.Streams interface makes all collection-based methods in UserFederatedUserCredentialStore default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserGroupMembershipFederatedStorage - Interface in org.keycloak.storage.federated

UserGroupMembershipFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserGroupMembershipFederatedStorage.Streams interface makes all collection-based methods in UserGroupMembershipFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

userLocalStorage() - Method in interface org.keycloak.models.KeycloakSession

Keycloak specific local storage for users.

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

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

The UserModel.Streams interface makes all collection-based methods in UserModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserModel.UserRemovedEvent - Interface in org.keycloak.models

UserModelDefaultMethods - Class in org.keycloak.models

UserModelDefaultMethods() - Constructor for class org.keycloak.models.UserModelDefaultMethods

UserModelDefaultMethods.Streams - Class in org.keycloak.models

The UserModelDefaultMethods.Streams class extends the UserModelDefaultMethods abstract class and implements the UserModel.Streams interface, allowing subclasses to focus on the implementation of the Stream-based query methods and providing default implementations for the collections-based variants that delegate to their Stream counterparts.

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

USERNAME - Static variable in interface org.keycloak.models.UserModel

UserNotBeforeFederatedStorage - Interface in org.keycloak.storage.federated

UserProvider - Interface in org.keycloak.models

UserProvider.Streams - Interface in org.keycloak.models

The UserProvider.Streams interface makes all collection-based methods in UserProvider default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

The UserQueryProvider.Streams interface makes all collection-based methods in UserQueryProvider default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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.

UserRequiredActionsFederatedStorage - Interface in org.keycloak.storage.federated

UserRequiredActionsFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserRequiredActionsFederatedStorage.Streams interface makes all collection-based methods in UserRequiredActionsFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

UserRoleMappingsFederatedStorage - Interface in org.keycloak.storage.federated

UserRoleMappingsFederatedStorage.Streams - Interface in org.keycloak.storage.federated

The UserRoleMappingsFederatedStorage.Streams interface makes all collection-based methods in UserRoleMappingsFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

Un-cached view of all users in system including users loaded by UserStorageProviders

UserStorageProvider - Interface in org.keycloak.storage

A class implementing this interface represents a user storage provider to Keycloak.

UserStorageProvider.EditMode - Enum in org.keycloak.storage

Optional type that can be used by implementations to describe edit mode of user storage

UserStorageProviderFactory<T extends UserStorageProvider> - Interface in org.keycloak.storage

UserStorageProviderModel - Class in org.keycloak.storage

Stored configuration of a User Storage provider instance.

UserStorageProviderModel() - Constructor for class org.keycloak.storage.UserStorageProviderModel

UserStorageProviderModel(ComponentModel) - Constructor for class org.keycloak.storage.UserStorageProviderModel

UserStorageProviderSpi - Class in org.keycloak.storage

UserStorageProviderSpi() - Constructor for class org.keycloak.storage.UserStorageProviderSpi

userVerificationRequirement - Variable in class org.keycloak.models.WebAuthnPolicy

V

validate(RealmModel) - Method in class org.keycloak.models.IdentityProviderModel

Validates this configuration.

validate(RealmModel, UserModel, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider

validate(String, String) - Method in interface org.keycloak.policy.PasswordPolicyProvider

validate(RealmModel, UserModel) - Method in interface org.keycloak.storage.user.ImportedUserValidation

If this method returns null, then the user in local storage will be removed

validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.component.ComponentFactory

Called before a component is created or updated.

validateConfiguration(KeycloakSession, RealmModel, ComponentModel) - Method in interface org.keycloak.storage.UserStorageProviderFactory

validateHOTP(String, String, int) - Method in class org.keycloak.models.utils.HmacOTP

validateSecret(String) - Method in interface org.keycloak.models.ClientModel

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.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.storage.CacheableStorageProviderModel.CachePolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.keycloak.storage.UserStorageProvider.EditMode

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.

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.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.storage.CacheableStorageProviderModel.CachePolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.keycloak.storage.UserStorageProvider.EditMode

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 a BiFunction whose implementation of the BiFunction.apply(Object, Object) method takes two Strings representing the realm name and the key name (as used in ${vault.key} expressions) and returns another String 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 or VaultStringSecret).

verify(String, PasswordCredentialModel) - Method in interface org.keycloak.credential.hash.PasswordHashProvider

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)

W

WebAuthnCredentialData - Class in org.keycloak.models.credential.dto

WebAuthnCredentialData(String, String, long, String, String, 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

weeklyTimeout(int, int, int) - Static method in class org.keycloak.storage.CacheableStorageProviderModel

X

X509CERTIFICATE - Static variable in interface org.keycloak.models.ClientModel

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