RealmModel (Keycloak Server SPI 13.0.0 API)

All Superinterfaces:

RoleContainerModel
```
public interface RealmModel
extends RoleContainerModel
```
Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`RealmModel.IdentityProviderRemovedEvent`
`static interface`	`RealmModel.IdentityProviderUpdatedEvent`
`static interface`	`RealmModel.RealmCreationEvent`
`static interface`	`RealmModel.RealmPostCreateEvent`
`static interface`	`RealmModel.RealmRemovedEvent`
`static class`	`RealmModel.SearchableFields`

Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel
RoleContainerModel.RoleRemovedEvent

Field Summary

Fields
Modifier and Type Field and Description

static Comparator<RealmModel> COMPARE_BY_NAME

Fields
Modifier and Type	Field and Description
`static Comparator<RealmModel>`	`COMPARE_BY_NAME`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`AuthenticationFlowModel`	`addAuthenticationFlow(AuthenticationFlowModel model)`
`AuthenticatorConfigModel`	`addAuthenticatorConfig(AuthenticatorConfigModel model)`
`AuthenticationExecutionModel`	`addAuthenticatorExecution(AuthenticationExecutionModel model)`
`ClientModel`	`addClient(String name)`
`ClientModel`	`addClient(String id, String clientId)`
`ClientScopeModel`	`addClientScope(String name)` Creates new client scope with the given name.
`ClientScopeModel`	`addClientScope(String id, String name)` Creates new client scope with the given internal ID and name.
`ComponentModel`	`addComponentModel(ComponentModel model)` Adds component model.
`void`	`addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)` Adds given client scope among default/optional client scopes of this realm.
`void`	`addDefaultGroup(GroupModel group)`
`void`	`addIdentityProvider(IdentityProviderModel identityProvider)`
`IdentityProviderMapperModel`	`addIdentityProviderMapper(IdentityProviderMapperModel model)`
`RequiredActionProviderModel`	`addRequiredActionProvider(RequiredActionProviderModel model)`
`void`	`addRequiredCredential(String cred)`
`default void`	`addToDefaultRoles(RoleModel role)` Adds a role as a composite to default role of this realm.
`ClientInitialAccessModel`	`createClientInitialAccessModel(int expiration, int count)`
`default GroupModel`	`createGroup(String name)`
`default GroupModel`	`createGroup(String name, GroupModel toParent)`
`default GroupModel`	`createGroup(String id, String name)`
`GroupModel`	`createGroup(String id, String name, GroupModel toParent)`
`void`	`decreaseRemainingCount(ClientInitialAccessModel clientInitialAccess)`
`int`	`getAccessCodeLifespan()`
`int`	`getAccessCodeLifespanLogin()`
`int`	`getAccessCodeLifespanUserAction()`
`int`	`getAccessTokenLifespan()`
`int`	`getAccessTokenLifespanForImplicitFlow()`
`String`	`getAccountTheme()`
`int`	`getActionTokenGeneratedByAdminLifespan()`
`int`	`getActionTokenGeneratedByUserLifespan()`
`int`	`getActionTokenGeneratedByUserLifespan(String actionTokenType)`
`String`	`getAdminTheme()`
`default List<ClientModel>`	`getAlwaysDisplayInConsoleClients()` Deprecated. Use `getAlwaysDisplayInConsoleClientsStream` instead.
`Stream<ClientModel>`	`getAlwaysDisplayInConsoleClientsStream()` Returns clients which are always displayed in the admin console as a stream.
`String`	`getAttribute(String name)`
`default Boolean`	`getAttribute(String name, Boolean defaultValue)`
`default Integer`	`getAttribute(String name, Integer defaultValue)`
`default Long`	`getAttribute(String name, Long defaultValue)`
`Map<String,String>`	`getAttributes()`
`AuthenticationExecutionModel`	`getAuthenticationExecutionByFlowId(String flowId)`
`AuthenticationExecutionModel`	`getAuthenticationExecutionById(String id)`
`default List<AuthenticationExecutionModel>`	`getAuthenticationExecutions(String flowId)` Deprecated. Use `getAuthenticationExecutionsStream` instead.
`Stream<AuthenticationExecutionModel>`	`getAuthenticationExecutionsStream(String flowId)` Returns sorted (according to priority) `AuthenticationExecutionModel` as a stream.
`AuthenticationFlowModel`	`getAuthenticationFlowById(String id)`
`default List<AuthenticationFlowModel>`	`getAuthenticationFlows()` Deprecated. Use `getAuthenticationFlowsStream` instead.
`Stream<AuthenticationFlowModel>`	`getAuthenticationFlowsStream()` Returns authentications flows as a stream.
`AuthenticatorConfigModel`	`getAuthenticatorConfigByAlias(String alias)`
`AuthenticatorConfigModel`	`getAuthenticatorConfigById(String id)`
`default List<AuthenticatorConfigModel>`	`getAuthenticatorConfigs()` Deprecated. Use `getAuthenticatorConfigsStream` instead.
`Stream<AuthenticatorConfigModel>`	`getAuthenticatorConfigsStream()` Returns authentication configs as a stream.
`AuthenticationFlowModel`	`getBrowserFlow()`
`Map<String,String>`	`getBrowserSecurityHeaders()`
`CibaConfig`	`getCibaPolicy()`
`AuthenticationFlowModel`	`getClientAuthenticationFlow()`
`ClientModel`	`getClientByClientId(String clientId)`
`ClientModel`	`getClientById(String id)`
`Stream<ClientInitialAccessModel>`	`getClientInitialAccesses()`
`ClientInitialAccessModel`	`getClientInitialAccessModel(String id)`
`int`	`getClientOfflineSessionIdleTimeout()`
`int`	`getClientOfflineSessionMaxLifespan()`
`default List<ClientModel>`	`getClients()` Deprecated. Use `getClientsStream` instead.
`default List<ClientModel>`	`getClients(Integer firstResult, Integer maxResults)` Deprecated. Use `getClientsStream` instead.
`ClientScopeModel`	`getClientScopeById(String id)`
`default List<ClientScopeModel>`	`getClientScopes()` Deprecated. Use `getClientScopesStream` instead.
`Stream<ClientScopeModel>`	`getClientScopesStream()` Returns all client scopes of this realm as a stream.
`Long`	`getClientsCount()`
`int`	`getClientSessionIdleTimeout()`
`int`	`getClientSessionMaxLifespan()`
`Stream<ClientModel>`	`getClientsStream()` Returns clients as a stream.
`Stream<ClientModel>`	`getClientsStream(Integer firstResult, Integer maxResults)` Returns clients as a stream.
`default List<ClientStorageProviderModel>`	`getClientStorageProviders()` Deprecated. Use `getClientStorageProvidersStream` instead.
`default Stream<ClientStorageProviderModel>`	`getClientStorageProvidersStream()` Returns sorted `ClientStorageProviderModel` as a stream.
`ComponentModel`	`getComponent(String id)`
`default List<ComponentModel>`	`getComponents()` Deprecated. Use `getComponentsStream` instead.
`default List<ComponentModel>`	`getComponents(String parentId)` Deprecated. Use `getComponentsStream` instead.
`default List<ComponentModel>`	`getComponents(String parentId, String providerType)` Deprecated. Use `getComponentsStream` instead.
`Stream<ComponentModel>`	`getComponentsStream()` Returns stream of component models.
`Stream<ComponentModel>`	`getComponentsStream(String parentId)` Returns stream of ComponentModels for specific parentId.
`Stream<ComponentModel>`	`getComponentsStream(String parentId, String providerType)` Returns stream of ComponentModels for specific parentId and providerType.
`default List<ClientScopeModel>`	`getDefaultClientScopes(boolean defaultScope)` Deprecated. Use `getDefaultClientScopesStream` instead.
`Stream<ClientScopeModel>`	`getDefaultClientScopesStream(boolean defaultScope)` Returns default client scopes of this realm either default ones or optional ones.
`default List<GroupModel>`	`getDefaultGroups()` Deprecated. Use `getDefaultGroupsStream` instead.
`Stream<GroupModel>`	`getDefaultGroupsStream()` Returns default groups as a stream.
`String`	`getDefaultLocale()`
`RoleModel`	`getDefaultRole()` Returns default realm role.
`String`	`getDefaultSignatureAlgorithm()`
`AuthenticationFlowModel`	`getDirectGrantFlow()`
`String`	`getDisplayName()`
`String`	`getDisplayNameHtml()`
`AuthenticationFlowModel`	`getDockerAuthenticationFlow()`
`String`	`getEmailTheme()`
`default Set<String>`	`getEnabledEventTypes()` Deprecated. Use `getEnabledEventTypesStream` instead.
`Stream<String>`	`getEnabledEventTypesStream()` Returns enabled event types as a stream.
`long`	`getEventsExpiration()`
`default Set<String>`	`getEventsListeners()` Deprecated. Use `getEventsListenersStream` instead.
`Stream<String>`	`getEventsListenersStream()` Returns events listeners as a stream.
`int`	`getFailureFactor()`
`AuthenticationFlowModel`	`getFlowByAlias(String alias)`
`GroupModel`	`getGroupById(String id)`
`default List<GroupModel>`	`getGroups()` Deprecated. Use `getGroupsStream` instead.
`Long`	`getGroupsCount(Boolean onlyTopGroups)`
`Long`	`getGroupsCountByNameContaining(String search)`
`Stream<GroupModel>`	`getGroupsStream()` Returns groups as a stream.
`String`	`getId()`
`IdentityProviderModel`	`getIdentityProviderByAlias(String alias)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperById(String id)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperByName(String brokerAlias, String name)`
`default Set<IdentityProviderMapperModel>`	`getIdentityProviderMappers()` Deprecated. Use `getIdentityProviderMappersStream` instead.
`default Set<IdentityProviderMapperModel>`	`getIdentityProviderMappersByAlias(String brokerAlias)` Deprecated. Use `getIdentityProviderMappersByAliasStream` instead.
`Stream<IdentityProviderMapperModel>`	`getIdentityProviderMappersByAliasStream(String brokerAlias)` Returns identity provider mappers by the provided alias as a stream.
`Stream<IdentityProviderMapperModel>`	`getIdentityProviderMappersStream()` Returns identity provider mappers as a stream.
`default List<IdentityProviderModel>`	`getIdentityProviders()` Deprecated. Use `getIdentityProvidersStream` instead.
`Stream<IdentityProviderModel>`	`getIdentityProvidersStream()` Returns identity providers as a stream.
`String`	`getLoginTheme()`
`ClientModel`	`getMasterAdminClient()`
`int`	`getMaxDeltaTimeSeconds()`
`int`	`getMaxFailureWaitSeconds()`
`int`	`getMinimumQuickLoginWaitSeconds()`
`String`	`getName()`
`int`	`getNotBefore()` Time in seconds since epoc
`OAuth2DeviceConfig`	`getOAuth2DeviceConfig()`
`int`	`getOfflineSessionIdleTimeout()`
`int`	`getOfflineSessionMaxLifespan()`
`OTPPolicy`	`getOTPPolicy()`
`PasswordPolicy`	`getPasswordPolicy()`
`long`	`getQuickLoginCheckMilliSeconds()`
`Map<String,Map<String,String>>`	`getRealmLocalizationTexts()`
`Map<String,String>`	`getRealmLocalizationTextsByLocale(String locale)`
`int`	`getRefreshTokenMaxReuse()`
`AuthenticationFlowModel`	`getRegistrationFlow()`
`RequiredActionProviderModel`	`getRequiredActionProviderByAlias(String alias)`
`RequiredActionProviderModel`	`getRequiredActionProviderById(String id)`
`default List<RequiredActionProviderModel>`	`getRequiredActionProviders()` Deprecated. Use `getRequiredActionProvidersStream` instead.
`Stream<RequiredActionProviderModel>`	`getRequiredActionProvidersStream()` Returns sorted `RequiredActionProviderModel` as a stream.
`default List<RequiredCredentialModel>`	`getRequiredCredentials()` Deprecated. Use `getRequiredCredentialsStream` instead.
`Stream<RequiredCredentialModel>`	`getRequiredCredentialsStream()` Returns required credentials as a stream.
`AuthenticationFlowModel`	`getResetCredentialsFlow()`
`RoleModel`	`getRoleById(String id)`
`default List<RoleStorageProviderModel>`	`getRoleStorageProviders()` Deprecated. Use `getRoleStorageProvidersStream` instead.
`default Stream<RoleStorageProviderModel>`	`getRoleStorageProvidersStream()` Returns sorted `RoleStorageProviderModel` as a stream.
`Map<String,String>`	`getSmtpConfig()`
`org.keycloak.common.enums.SslRequired`	`getSslRequired()`
`int`	`getSsoSessionIdleTimeout()`
`int`	`getSsoSessionIdleTimeoutRememberMe()`
`int`	`getSsoSessionMaxLifespan()`
`int`	`getSsoSessionMaxLifespanRememberMe()`
`default Stream<ComponentModel>`	`getStorageProviders(Class<? extends Provider> storageProviderClass)` Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.
`default Set<String>`	`getSupportedLocales()` Deprecated. Use `getSupportedLocalesStream` instead.
`Stream<String>`	`getSupportedLocalesStream()` Returns supported locales as a stream.
`default List<GroupModel>`	`getTopLevelGroups()` Deprecated. Use `getTopLevelGroups` instead.
`default List<GroupModel>`	`getTopLevelGroups(Integer first, Integer max)` Deprecated. Use `getTopLevelGroupsStream` instead.
`Stream<GroupModel>`	`getTopLevelGroupsStream()` Returns top level groups as a stream.
`Stream<GroupModel>`	`getTopLevelGroupsStream(Integer first, Integer max)` Returns top level groups as a stream.
`Map<String,Integer>`	`getUserActionTokenLifespans()` This method will return a map with all the lifespans available or an empty map, but never null.
`default List<UserStorageProviderModel>`	`getUserStorageProviders()` Deprecated. Use `getUserStorageProvidersStream` instead.
`default Stream<UserStorageProviderModel>`	`getUserStorageProvidersStream()` Returns sorted `UserStorageProviderModel` as a stream.
`int`	`getWaitIncrementSeconds()`
`WebAuthnPolicy`	`getWebAuthnPolicy()`
`WebAuthnPolicy`	`getWebAuthnPolicyPasswordless()`
`ComponentModel`	`importComponentModel(ComponentModel model)` Adds component model.
`boolean`	`isAdminEventsDetailsEnabled()`
`boolean`	`isAdminEventsEnabled()`
`boolean`	`isBruteForceProtected()`
`boolean`	`isDuplicateEmailsAllowed()`
`boolean`	`isEditUsernameAllowed()`
`boolean`	`isEnabled()`
`boolean`	`isEventsEnabled()`
`boolean`	`isIdentityFederationEnabled()`
`boolean`	`isInternationalizationEnabled()`
`boolean`	`isLoginWithEmailAllowed()`
`boolean`	`isOfflineSessionMaxLifespanEnabled()`
`boolean`	`isPermanentLockout()`
`boolean`	`isRegistrationAllowed()`
`boolean`	`isRegistrationEmailAsUsername()`
`boolean`	`isRememberMe()`
`boolean`	`isResetPasswordAllowed()`
`boolean`	`isRevokeRefreshToken()`
`boolean`	`isUserManagedAccessAllowed()`
`boolean`	`isVerifyEmail()`
`void`	`moveGroup(GroupModel group, GroupModel toParent)`
`void`	`patchRealmLocalizationTexts(String locale, Map<String,String> localizationTexts)` Patches the realm-specific localization texts.
`void`	`removeAttribute(String name)`
`void`	`removeAuthenticationFlow(AuthenticationFlowModel model)`
`void`	`removeAuthenticatorConfig(AuthenticatorConfigModel model)`
`void`	`removeAuthenticatorExecution(AuthenticationExecutionModel model)`
`boolean`	`removeClient(String id)`
`void`	`removeClientInitialAccessModel(String id)`
`boolean`	`removeClientScope(String id)` Removes client scope with given `id` from this realm.
`void`	`removeComponent(ComponentModel component)` Removes given component.
`void`	`removeComponents(String parentId)` Removes all components with given `parentId`
`void`	`removeDefaultClientScope(ClientScopeModel clientScope)` Removes given client scope from default or optional client scopes of this realm.
`void`	`removeDefaultGroup(GroupModel group)`
`boolean`	`removeGroup(GroupModel group)`
`void`	`removeIdentityProviderByAlias(String alias)`
`void`	`removeIdentityProviderMapper(IdentityProviderMapperModel mapping)`
`boolean`	`removeRealmLocalizationTexts(String locale)`
`void`	`removeRequiredActionProvider(RequiredActionProviderModel model)`
`default List<ClientModel>`	`searchClientByClientId(String clientId, Integer firstResult, Integer maxResults)` Deprecated. Use `searchClientByClientId` instead.
`Stream<ClientModel>`	`searchClientByClientIdStream(String clientId, Integer firstResult, Integer maxResults)` Search for clients by provided client's id.
`default List<GroupModel>`	`searchForGroupByName(String search, Integer first, Integer max)` Deprecated. Use `searchForGroupByName` instead.
`Stream<GroupModel>`	`searchForGroupByNameStream(String search, Integer first, Integer max)` Searches for groups by provided name.
`void`	`setAccessCodeLifespan(int seconds)`
`void`	`setAccessCodeLifespanLogin(int seconds)`
`void`	`setAccessCodeLifespanUserAction(int seconds)`
`void`	`setAccessTokenLifespan(int seconds)`
`void`	`setAccessTokenLifespanForImplicitFlow(int seconds)`
`void`	`setAccountTheme(String name)`
`void`	`setActionTokenGeneratedByAdminLifespan(int seconds)`
`void`	`setActionTokenGeneratedByUserLifespan(int seconds)`
`void`	`setActionTokenGeneratedByUserLifespan(String actionTokenType, Integer seconds)`
`void`	`setAdminEventsDetailsEnabled(boolean enabled)`
`void`	`setAdminEventsEnabled(boolean enabled)`
`void`	`setAdminTheme(String name)`
`default void`	`setAttribute(String name, Boolean value)`
`default void`	`setAttribute(String name, Integer value)`
`default void`	`setAttribute(String name, Long value)`
`void`	`setAttribute(String name, String value)`
`void`	`setBrowserFlow(AuthenticationFlowModel flow)`
`void`	`setBrowserSecurityHeaders(Map<String,String> headers)`
`void`	`setBruteForceProtected(boolean value)`
`void`	`setClientAuthenticationFlow(AuthenticationFlowModel flow)`
`void`	`setClientOfflineSessionIdleTimeout(int seconds)`
`void`	`setClientOfflineSessionMaxLifespan(int seconds)`
`void`	`setClientSessionIdleTimeout(int seconds)`
`void`	`setClientSessionMaxLifespan(int seconds)`
`void`	`setDefaultLocale(String locale)`
`void`	`setDefaultRole(RoleModel role)` Sets default role for this realm
`void`	`setDefaultSignatureAlgorithm(String defaultSignatureAlgorithm)`
`void`	`setDirectGrantFlow(AuthenticationFlowModel flow)`
`void`	`setDisplayName(String displayName)`
`void`	`setDisplayNameHtml(String displayNameHtml)`
`void`	`setDockerAuthenticationFlow(AuthenticationFlowModel flow)`
`void`	`setDuplicateEmailsAllowed(boolean duplicateEmailsAllowed)`
`void`	`setEditUsernameAllowed(boolean editUsernameAllowed)`
`void`	`setEmailTheme(String name)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabledEventTypes(Set<String> enabledEventTypes)`
`void`	`setEventsEnabled(boolean enabled)`
`void`	`setEventsExpiration(long expiration)`
`void`	`setEventsListeners(Set<String> listeners)`
`void`	`setFailureFactor(int failureFactor)`
`void`	`setInternationalizationEnabled(boolean enabled)`
`void`	`setLoginTheme(String name)`
`void`	`setLoginWithEmailAllowed(boolean loginWithEmailAllowed)`
`void`	`setMasterAdminClient(ClientModel client)`
`void`	`setMaxDeltaTimeSeconds(int val)`
`void`	`setMaxFailureWaitSeconds(int val)`
`void`	`setMinimumQuickLoginWaitSeconds(int val)`
`void`	`setName(String name)`
`void`	`setNotBefore(int notBefore)`
`void`	`setOfflineSessionIdleTimeout(int seconds)`
`void`	`setOfflineSessionMaxLifespan(int seconds)`
`void`	`setOfflineSessionMaxLifespanEnabled(boolean offlineSessionMaxLifespanEnabled)`
`void`	`setOTPPolicy(OTPPolicy policy)`
`void`	`setPasswordPolicy(PasswordPolicy policy)`
`void`	`setPermanentLockout(boolean val)`
`void`	`setQuickLoginCheckMilliSeconds(long val)`
`void`	`setRefreshTokenMaxReuse(int revokeRefreshTokenCount)`
`void`	`setRegistrationAllowed(boolean registrationAllowed)`
`void`	`setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)`
`void`	`setRegistrationFlow(AuthenticationFlowModel flow)`
`void`	`setRememberMe(boolean rememberMe)`
`void`	`setResetCredentialsFlow(AuthenticationFlowModel flow)`
`void`	`setResetPasswordAllowed(boolean resetPasswordAllowed)`
`void`	`setRevokeRefreshToken(boolean revokeRefreshToken)`
`void`	`setSmtpConfig(Map<String,String> smtpConfig)`
`void`	`setSslRequired(org.keycloak.common.enums.SslRequired sslRequired)`
`void`	`setSsoSessionIdleTimeout(int seconds)`
`void`	`setSsoSessionIdleTimeoutRememberMe(int seconds)`
`void`	`setSsoSessionMaxLifespan(int seconds)`
`void`	`setSsoSessionMaxLifespanRememberMe(int seconds)`
`void`	`setSupportedLocales(Set<String> locales)`
`void`	`setUserManagedAccessAllowed(boolean userManagedAccessAllowed)`
`void`	`setVerifyEmail(boolean verifyEmail)`
`void`	`setWaitIncrementSeconds(int val)`
`void`	`setWebAuthnPolicy(WebAuthnPolicy policy)` Set WebAuthn policy for 2-factor authentication
`void`	`setWebAuthnPolicyPasswordless(WebAuthnPolicy policy)` Set WebAuthn passwordless policy below.
`void`	`updateAuthenticationFlow(AuthenticationFlowModel model)`
`void`	`updateAuthenticatorConfig(AuthenticatorConfigModel model)`
`void`	`updateAuthenticatorExecution(AuthenticationExecutionModel model)`
`void`	`updateComponent(ComponentModel component)` Updates component model.
`void`	`updateIdentityProvider(IdentityProviderModel identityProvider)`
`void`	`updateIdentityProviderMapper(IdentityProviderMapperModel mapping)`
`void`	`updateRequiredActionProvider(RequiredActionProviderModel model)`
`void`	`updateRequiredCredentials(Set<String> creds)`

Methods inherited from interface org.keycloak.models.RoleContainerModel
addDefaultRole, addRole, addRole, getDefaultRoles, getDefaultRolesStream, getRole, getRoles, getRoles, getRolesStream, getRolesStream, removeDefaultRoles, removeRole, searchForRoles, searchForRolesStream, updateDefaultRoles

Field Detail

COMPARE_BY_NAME

static final Comparator<RealmModel> COMPARE_BY_NAME

Method Detail

getId
```
String getId()
```
Specified by:

getId in interface RoleContainerModel

getName
```
String getName()
```

setName
```
void setName(String name)
```

getDisplayName
```
String getDisplayName()
```

setDisplayName

void setDisplayName(String displayName)

getDisplayNameHtml
```
String getDisplayNameHtml()
```

setDisplayNameHtml

void setDisplayNameHtml(String displayNameHtml)

isEnabled
```
boolean isEnabled()
```

setEnabled
```
void setEnabled(boolean enabled)
```

getSslRequired

org.keycloak.common.enums.SslRequired getSslRequired()

setSslRequired

void setSslRequired(org.keycloak.common.enums.SslRequired sslRequired)

isRegistrationAllowed
```
boolean isRegistrationAllowed()
```

setRegistrationAllowed

void setRegistrationAllowed(boolean registrationAllowed)

isRegistrationEmailAsUsername

boolean isRegistrationEmailAsUsername()

setRegistrationEmailAsUsername

void setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)

isRememberMe
```
boolean isRememberMe()
```

setRememberMe

void setRememberMe(boolean rememberMe)

isEditUsernameAllowed
```
boolean isEditUsernameAllowed()
```

setEditUsernameAllowed

void setEditUsernameAllowed(boolean editUsernameAllowed)

isUserManagedAccessAllowed
```
boolean isUserManagedAccessAllowed()
```

setUserManagedAccessAllowed

void setUserManagedAccessAllowed(boolean userManagedAccessAllowed)

setAttribute

void setAttribute(String name,
                  String value)

setAttribute

default void setAttribute(String name,
                          Boolean value)

setAttribute

default void setAttribute(String name,
                          Integer value)

setAttribute

default void setAttribute(String name,
                          Long value)

removeAttribute
```
void removeAttribute(String name)
```

getAttribute
```
String getAttribute(String name)
```

getAttribute

default Integer getAttribute(String name,
                             Integer defaultValue)

getAttribute

default Long getAttribute(String name,
                          Long defaultValue)

getAttribute

default Boolean getAttribute(String name,
                             Boolean defaultValue)

getAttributes
```
Map<String,String> getAttributes()
```

isBruteForceProtected
```
boolean isBruteForceProtected()
```

setBruteForceProtected

void setBruteForceProtected(boolean value)

isPermanentLockout
```
boolean isPermanentLockout()
```

setPermanentLockout
```
void setPermanentLockout(boolean val)
```

getMaxFailureWaitSeconds
```
int getMaxFailureWaitSeconds()
```

setMaxFailureWaitSeconds

void setMaxFailureWaitSeconds(int val)

getWaitIncrementSeconds
```
int getWaitIncrementSeconds()
```

setWaitIncrementSeconds
```
void setWaitIncrementSeconds(int val)
```

getMinimumQuickLoginWaitSeconds
```
int getMinimumQuickLoginWaitSeconds()
```

setMinimumQuickLoginWaitSeconds

void setMinimumQuickLoginWaitSeconds(int val)

getQuickLoginCheckMilliSeconds
```
long getQuickLoginCheckMilliSeconds()
```

setQuickLoginCheckMilliSeconds

void setQuickLoginCheckMilliSeconds(long val)

getMaxDeltaTimeSeconds
```
int getMaxDeltaTimeSeconds()
```

setMaxDeltaTimeSeconds
```
void setMaxDeltaTimeSeconds(int val)
```

getFailureFactor
```
int getFailureFactor()
```

setFailureFactor

void setFailureFactor(int failureFactor)

isVerifyEmail
```
boolean isVerifyEmail()
```

setVerifyEmail

void setVerifyEmail(boolean verifyEmail)

isLoginWithEmailAllowed
```
boolean isLoginWithEmailAllowed()
```

setLoginWithEmailAllowed

void setLoginWithEmailAllowed(boolean loginWithEmailAllowed)

isDuplicateEmailsAllowed
```
boolean isDuplicateEmailsAllowed()
```

setDuplicateEmailsAllowed

void setDuplicateEmailsAllowed(boolean duplicateEmailsAllowed)

isResetPasswordAllowed
```
boolean isResetPasswordAllowed()
```

setResetPasswordAllowed

void setResetPasswordAllowed(boolean resetPasswordAllowed)

getDefaultSignatureAlgorithm
```
String getDefaultSignatureAlgorithm()
```

setDefaultSignatureAlgorithm

void setDefaultSignatureAlgorithm(String defaultSignatureAlgorithm)

isRevokeRefreshToken
```
boolean isRevokeRefreshToken()
```

setRevokeRefreshToken

void setRevokeRefreshToken(boolean revokeRefreshToken)

getRefreshTokenMaxReuse
```
int getRefreshTokenMaxReuse()
```

setRefreshTokenMaxReuse

void setRefreshTokenMaxReuse(int revokeRefreshTokenCount)

getSsoSessionIdleTimeout
```
int getSsoSessionIdleTimeout()
```

setSsoSessionIdleTimeout

void setSsoSessionIdleTimeout(int seconds)

getSsoSessionMaxLifespan
```
int getSsoSessionMaxLifespan()
```

setSsoSessionMaxLifespan

void setSsoSessionMaxLifespan(int seconds)

getSsoSessionIdleTimeoutRememberMe

int getSsoSessionIdleTimeoutRememberMe()

setSsoSessionIdleTimeoutRememberMe

void setSsoSessionIdleTimeoutRememberMe(int seconds)

getSsoSessionMaxLifespanRememberMe

int getSsoSessionMaxLifespanRememberMe()

setSsoSessionMaxLifespanRememberMe

void setSsoSessionMaxLifespanRememberMe(int seconds)

getOfflineSessionIdleTimeout
```
int getOfflineSessionIdleTimeout()
```

setOfflineSessionIdleTimeout

void setOfflineSessionIdleTimeout(int seconds)

getAccessTokenLifespan
```
int getAccessTokenLifespan()
```

isOfflineSessionMaxLifespanEnabled

boolean isOfflineSessionMaxLifespanEnabled()

setOfflineSessionMaxLifespanEnabled

void setOfflineSessionMaxLifespanEnabled(boolean offlineSessionMaxLifespanEnabled)

getOfflineSessionMaxLifespan
```
int getOfflineSessionMaxLifespan()
```

setOfflineSessionMaxLifespan

void setOfflineSessionMaxLifespan(int seconds)

getClientSessionIdleTimeout
```
int getClientSessionIdleTimeout()
```

setClientSessionIdleTimeout

void setClientSessionIdleTimeout(int seconds)

getClientSessionMaxLifespan
```
int getClientSessionMaxLifespan()
```

setClientSessionMaxLifespan

void setClientSessionMaxLifespan(int seconds)

getClientOfflineSessionIdleTimeout

int getClientOfflineSessionIdleTimeout()

setClientOfflineSessionIdleTimeout

void setClientOfflineSessionIdleTimeout(int seconds)

getClientOfflineSessionMaxLifespan

int getClientOfflineSessionMaxLifespan()

setClientOfflineSessionMaxLifespan

void setClientOfflineSessionMaxLifespan(int seconds)

setAccessTokenLifespan

void setAccessTokenLifespan(int seconds)

getAccessTokenLifespanForImplicitFlow

int getAccessTokenLifespanForImplicitFlow()

setAccessTokenLifespanForImplicitFlow

void setAccessTokenLifespanForImplicitFlow(int seconds)

getAccessCodeLifespan
```
int getAccessCodeLifespan()
```

setAccessCodeLifespan

void setAccessCodeLifespan(int seconds)

getAccessCodeLifespanUserAction
```
int getAccessCodeLifespanUserAction()
```

setAccessCodeLifespanUserAction

void setAccessCodeLifespanUserAction(int seconds)

getOAuth2DeviceConfig

OAuth2DeviceConfig getOAuth2DeviceConfig()

getCibaPolicy
```
CibaConfig getCibaPolicy()
```

getUserActionTokenLifespans
```
Map<String,Integer> getUserActionTokenLifespans()
```
This method will return a map with all the lifespans available or an empty map, but never null.

Returns:

map with user action token lifespans

getAccessCodeLifespanLogin
```
int getAccessCodeLifespanLogin()
```

setAccessCodeLifespanLogin

void setAccessCodeLifespanLogin(int seconds)

getActionTokenGeneratedByAdminLifespan

int getActionTokenGeneratedByAdminLifespan()

setActionTokenGeneratedByAdminLifespan

void setActionTokenGeneratedByAdminLifespan(int seconds)

getActionTokenGeneratedByUserLifespan

int getActionTokenGeneratedByUserLifespan()

setActionTokenGeneratedByUserLifespan

void setActionTokenGeneratedByUserLifespan(int seconds)

getActionTokenGeneratedByUserLifespan

int getActionTokenGeneratedByUserLifespan(String actionTokenType)

setActionTokenGeneratedByUserLifespan

void setActionTokenGeneratedByUserLifespan(String actionTokenType,
                                           Integer seconds)

getRequiredCredentials

@Deprecated
default List<RequiredCredentialModel> getRequiredCredentials()

Deprecated. Use getRequiredCredentialsStream instead.

getRequiredCredentialsStream
```
Stream<RequiredCredentialModel> getRequiredCredentialsStream()
```
Returns required credentials as a stream.

Returns:

Stream of RequiredCredentialModel. Never returns null.

addRequiredCredential

void addRequiredCredential(String cred)

getPasswordPolicy
```
PasswordPolicy getPasswordPolicy()
```

setPasswordPolicy

void setPasswordPolicy(PasswordPolicy policy)

getOTPPolicy
```
OTPPolicy getOTPPolicy()
```

setOTPPolicy
```
void setOTPPolicy(OTPPolicy policy)
```

getWebAuthnPolicy
```
WebAuthnPolicy getWebAuthnPolicy()
```
Returns:

WebAuthn policy for 2-factor authentication

setWebAuthnPolicy
```
void setWebAuthnPolicy(WebAuthnPolicy policy)
```
Set WebAuthn policy for 2-factor authentication

Parameters:

policy -

getWebAuthnPolicyPasswordless
```
WebAuthnPolicy getWebAuthnPolicyPasswordless()
```
Returns:

WebAuthn passwordless policy below. This is temporary and will be removed later.

setWebAuthnPolicyPasswordless
```
void setWebAuthnPolicyPasswordless(WebAuthnPolicy policy)
```
Set WebAuthn passwordless policy below. This is temporary and will be removed later.

Parameters:

policy -

getRoleById
```
RoleModel getRoleById(String id)
```

getDefaultGroups

@Deprecated
default List<GroupModel> getDefaultGroups()

Deprecated. Use getDefaultGroupsStream instead.

getDefaultGroupsStream
```
Stream<GroupModel> getDefaultGroupsStream()
```
Returns default groups as a stream.

Returns:

Stream of GroupModel. Never returns null.

addDefaultGroup

void addDefaultGroup(GroupModel group)

removeDefaultGroup

void removeDefaultGroup(GroupModel group)

getClients

@Deprecated
default List<ClientModel> getClients()

Deprecated. Use getClientsStream instead.

getClientsStream
```
Stream<ClientModel> getClientsStream()
```
Returns clients as a stream.

Returns:

Stream of ClientModel. Never returns null.

getClients

@Deprecated
default List<ClientModel> getClients(Integer firstResult,
                                                 Integer maxResults)

Deprecated. Use getClientsStream instead.

getClientsStream
```
Stream<ClientModel> getClientsStream(Integer firstResult,
                                     Integer maxResults)
```
Returns clients as a stream.

Parameters:

firstResult - Integer Index of the first desired client. Ignored if negative or null.

maxResults - Integer Maximum number of returned clients. Ignored if negative or null.

Returns:

Stream of ClientModel. Never returns null.

getClientsCount
```
Long getClientsCount()
```

getAlwaysDisplayInConsoleClients
```
@Deprecated
default List<ClientModel> getAlwaysDisplayInConsoleClients()
```
Deprecated. Use getAlwaysDisplayInConsoleClientsStream instead.

getAlwaysDisplayInConsoleClientsStream
```
Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream()
```
Returns clients which are always displayed in the admin console as a stream.

Returns:

Stream of ClientModel. Never returns null.

addClient
```
ClientModel addClient(String name)
```

addClient

ClientModel addClient(String id,
                      String clientId)

removeClient
```
boolean removeClient(String id)
```

getClientById
```
ClientModel getClientById(String id)
```

getClientByClientId

ClientModel getClientByClientId(String clientId)

searchClientByClientId

@Deprecated
default List<ClientModel> searchClientByClientId(String clientId,
                                                             Integer firstResult,
                                                             Integer maxResults)

Deprecated. Use searchClientByClientId instead.

searchClientByClientIdStream

Stream<ClientModel> searchClientByClientIdStream(String clientId,
                                                 Integer firstResult,
                                                 Integer maxResults)

Search for clients by provided client's id.

Parameters:: clientId - String Id of the client.; firstResult - Index of the first desired client. Ignored if negative or null.; maxResults - Maximum number of returned clients. Ignored if negative or null.
Returns:: Stream of ClientModel. Never returns null.

updateRequiredCredentials

void updateRequiredCredentials(Set<String> creds)

getBrowserSecurityHeaders

Map<String,String> getBrowserSecurityHeaders()

setBrowserSecurityHeaders

void setBrowserSecurityHeaders(Map<String,String> headers)

getSmtpConfig
```
Map<String,String> getSmtpConfig()
```

setSmtpConfig

void setSmtpConfig(Map<String,String> smtpConfig)

getBrowserFlow

AuthenticationFlowModel getBrowserFlow()

setBrowserFlow

void setBrowserFlow(AuthenticationFlowModel flow)

getRegistrationFlow

AuthenticationFlowModel getRegistrationFlow()

setRegistrationFlow

void setRegistrationFlow(AuthenticationFlowModel flow)

getDirectGrantFlow

AuthenticationFlowModel getDirectGrantFlow()

setDirectGrantFlow

void setDirectGrantFlow(AuthenticationFlowModel flow)

getResetCredentialsFlow

AuthenticationFlowModel getResetCredentialsFlow()

setResetCredentialsFlow

void setResetCredentialsFlow(AuthenticationFlowModel flow)

getClientAuthenticationFlow

AuthenticationFlowModel getClientAuthenticationFlow()

setClientAuthenticationFlow

void setClientAuthenticationFlow(AuthenticationFlowModel flow)

getDockerAuthenticationFlow

AuthenticationFlowModel getDockerAuthenticationFlow()

setDockerAuthenticationFlow

void setDockerAuthenticationFlow(AuthenticationFlowModel flow)

getAuthenticationFlows

@Deprecated
default List<AuthenticationFlowModel> getAuthenticationFlows()

Deprecated. Use getAuthenticationFlowsStream instead.

getAuthenticationFlowsStream
```
Stream<AuthenticationFlowModel> getAuthenticationFlowsStream()
```
Returns authentications flows as a stream.

Returns:

Stream of AuthenticationFlowModel. Never returns null.

getFlowByAlias

AuthenticationFlowModel getFlowByAlias(String alias)

addAuthenticationFlow

AuthenticationFlowModel addAuthenticationFlow(AuthenticationFlowModel model)

getAuthenticationFlowById

AuthenticationFlowModel getAuthenticationFlowById(String id)

removeAuthenticationFlow

void removeAuthenticationFlow(AuthenticationFlowModel model)

updateAuthenticationFlow

void updateAuthenticationFlow(AuthenticationFlowModel model)

getAuthenticationExecutions

@Deprecated
default List<AuthenticationExecutionModel> getAuthenticationExecutions(String flowId)

Deprecated. Use getAuthenticationExecutionsStream instead.

getAuthenticationExecutionsStream
```
Stream<AuthenticationExecutionModel> getAuthenticationExecutionsStream(String flowId)
```
Returns sorted (according to priority) AuthenticationExecutionModel as a stream. It should be used with forEachOrdered if the ordering is required.

Parameters:

flowId - String Id of the flow.

Returns:

Sorted stream of AuthenticationExecutionModel. Never returns null.

getAuthenticationExecutionById

AuthenticationExecutionModel getAuthenticationExecutionById(String id)

getAuthenticationExecutionByFlowId

AuthenticationExecutionModel getAuthenticationExecutionByFlowId(String flowId)

addAuthenticatorExecution

AuthenticationExecutionModel addAuthenticatorExecution(AuthenticationExecutionModel model)

updateAuthenticatorExecution

void updateAuthenticatorExecution(AuthenticationExecutionModel model)

removeAuthenticatorExecution

void removeAuthenticatorExecution(AuthenticationExecutionModel model)

getAuthenticatorConfigs

@Deprecated
default List<AuthenticatorConfigModel> getAuthenticatorConfigs()

Deprecated. Use getAuthenticatorConfigsStream instead.

getAuthenticatorConfigsStream
```
Stream<AuthenticatorConfigModel> getAuthenticatorConfigsStream()
```
Returns authentication configs as a stream.

Returns:

Stream of AuthenticatorConfigModel. Never returns null.

addAuthenticatorConfig

AuthenticatorConfigModel addAuthenticatorConfig(AuthenticatorConfigModel model)

updateAuthenticatorConfig

void updateAuthenticatorConfig(AuthenticatorConfigModel model)

removeAuthenticatorConfig

void removeAuthenticatorConfig(AuthenticatorConfigModel model)

getAuthenticatorConfigById

AuthenticatorConfigModel getAuthenticatorConfigById(String id)

getAuthenticatorConfigByAlias

AuthenticatorConfigModel getAuthenticatorConfigByAlias(String alias)

getRequiredActionProviders

@Deprecated
default List<RequiredActionProviderModel> getRequiredActionProviders()

Deprecated. Use getRequiredActionProvidersStream instead.

getRequiredActionProvidersStream
```
Stream<RequiredActionProviderModel> getRequiredActionProvidersStream()
```
Returns sorted RequiredActionProviderModel as a stream. It should be used with forEachOrdered if the ordering is required.

Returns:

Sorted stream of RequiredActionProviderModel. Never returns null.

addRequiredActionProvider

RequiredActionProviderModel addRequiredActionProvider(RequiredActionProviderModel model)

updateRequiredActionProvider

void updateRequiredActionProvider(RequiredActionProviderModel model)

removeRequiredActionProvider

void removeRequiredActionProvider(RequiredActionProviderModel model)

getRequiredActionProviderById

RequiredActionProviderModel getRequiredActionProviderById(String id)

getRequiredActionProviderByAlias

RequiredActionProviderModel getRequiredActionProviderByAlias(String alias)

getIdentityProviders

@Deprecated
default List<IdentityProviderModel> getIdentityProviders()

Deprecated. Use getIdentityProvidersStream instead.

getIdentityProvidersStream
```
Stream<IdentityProviderModel> getIdentityProvidersStream()
```
Returns identity providers as a stream.

Returns:

Stream of IdentityProviderModel. Never returns null.

getIdentityProviderByAlias

IdentityProviderModel getIdentityProviderByAlias(String alias)

addIdentityProvider

void addIdentityProvider(IdentityProviderModel identityProvider)

removeIdentityProviderByAlias

void removeIdentityProviderByAlias(String alias)

updateIdentityProvider

void updateIdentityProvider(IdentityProviderModel identityProvider)

getIdentityProviderMappers

@Deprecated
default Set<IdentityProviderMapperModel> getIdentityProviderMappers()

Deprecated. Use getIdentityProviderMappersStream instead.

getIdentityProviderMappersStream
```
Stream<IdentityProviderMapperModel> getIdentityProviderMappersStream()
```
Returns identity provider mappers as a stream.

Returns:

Stream of IdentityProviderMapperModel. Never returns null.

getIdentityProviderMappersByAlias

@Deprecated
default Set<IdentityProviderMapperModel> getIdentityProviderMappersByAlias(String brokerAlias)

Deprecated. Use getIdentityProviderMappersByAliasStream instead.

getIdentityProviderMappersByAliasStream
```
Stream<IdentityProviderMapperModel> getIdentityProviderMappersByAliasStream(String brokerAlias)
```
Returns identity provider mappers by the provided alias as a stream.

Parameters:

brokerAlias - String Broker's alias to filter results.

Returns:

Stream of IdentityProviderMapperModel Never returns null.

addIdentityProviderMapper

IdentityProviderMapperModel addIdentityProviderMapper(IdentityProviderMapperModel model)

removeIdentityProviderMapper

void removeIdentityProviderMapper(IdentityProviderMapperModel mapping)

updateIdentityProviderMapper

void updateIdentityProviderMapper(IdentityProviderMapperModel mapping)

getIdentityProviderMapperById

IdentityProviderMapperModel getIdentityProviderMapperById(String id)

getIdentityProviderMapperByName

IdentityProviderMapperModel getIdentityProviderMapperByName(String brokerAlias,
                                                            String name)

addComponentModel
```
ComponentModel addComponentModel(ComponentModel model)
```
Adds component model. Will call onCreate() method of ComponentFactory

Parameters:

model -

Returns:

importComponentModel
```
ComponentModel importComponentModel(ComponentModel model)
```
Adds component model. Will NOT call onCreate() method of ComponentFactory

Parameters:

model -

Returns:

updateComponent
```
void updateComponent(ComponentModel component)
```
Updates component model. Will call onUpdate() method of ComponentFactory

Parameters:

component - to be updated

removeComponent
```
void removeComponent(ComponentModel component)
```
Removes given component. Will call preRemove() method of ComponentFactory. Also calls this.removeComponents(component.getId()).

Parameters:

component - to be removed

removeComponents
```
void removeComponents(String parentId)
```
Removes all components with given parentId

Parameters:

parentId - String id of parent

getComponents

@Deprecated
default List<ComponentModel> getComponents(String parentId,
                                                       String providerType)

Deprecated. Use getComponentsStream instead.

getComponentsStream
```
Stream<ComponentModel> getComponentsStream(String parentId,
                                           String providerType)
```
Returns stream of ComponentModels for specific parentId and providerType.

Parameters:

parentId - String id of parent

providerType - String type of provider

Returns:

Stream of ComponentModel. Never returns null.

getComponentsStream
```
Stream<ComponentModel> getComponentsStream(String parentId)
```
Returns stream of ComponentModels for specific parentId.

Parameters:

parentId - String id of parent

Returns:

Stream of ComponentModel. Never returns null.

getComponents

@Deprecated
default List<ComponentModel> getComponents(String parentId)

Deprecated. Use getComponentsStream instead.

getComponents

@Deprecated
default List<ComponentModel> getComponents()

Deprecated. Use getComponentsStream instead.

getComponentsStream
```
Stream<ComponentModel> getComponentsStream()
```
Returns stream of component models.

Returns:

Stream of ComponentModel. Never returns null.

getComponent

ComponentModel getComponent(String id)

getUserStorageProviders

@Deprecated
default List<UserStorageProviderModel> getUserStorageProviders()

Deprecated. Use getUserStorageProvidersStream instead.

getUserStorageProvidersStream
```
default Stream<UserStorageProviderModel> getUserStorageProvidersStream()
```
Returns sorted UserStorageProviderModel as a stream. It should be used with forEachOrdered if the ordering is required.

Returns:

Sorted stream of UserStorageProviderModel. Never returns null.

getClientStorageProviders

@Deprecated
default List<ClientStorageProviderModel> getClientStorageProviders()

Deprecated. Use getClientStorageProvidersStream instead.

getClientStorageProvidersStream
```
default Stream<ClientStorageProviderModel> getClientStorageProvidersStream()
```
Returns sorted ClientStorageProviderModel as a stream. It should be used with forEachOrdered if the ordering is required.

Returns:

Sorted stream of ClientStorageProviderModel. Never returns null.

getRoleStorageProviders

@Deprecated
default List<RoleStorageProviderModel> getRoleStorageProviders()

Deprecated. Use getRoleStorageProvidersStream instead.

getRoleStorageProvidersStream
```
default Stream<RoleStorageProviderModel> getRoleStorageProvidersStream()
```
Returns sorted RoleStorageProviderModel as a stream. It should be used with forEachOrdered if the ordering is required.

Returns:

Sorted stream of RoleStorageProviderModel. Never returns null.

getStorageProviders
```
default Stream<ComponentModel> getStorageProviders(Class<? extends Provider> storageProviderClass)
```
Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.

Parameters:

storageProviderClass - Class<? extends Provider>

Returns:

Stream of ComponentModel. Never returns null.

getLoginTheme
```
String getLoginTheme()
```

setLoginTheme
```
void setLoginTheme(String name)
```

getAccountTheme
```
String getAccountTheme()
```

setAccountTheme
```
void setAccountTheme(String name)
```

getAdminTheme
```
String getAdminTheme()
```

setAdminTheme
```
void setAdminTheme(String name)
```

getEmailTheme
```
String getEmailTheme()
```

setEmailTheme
```
void setEmailTheme(String name)
```

getNotBefore
```
int getNotBefore()
```
Time in seconds since epoc

Returns:

setNotBefore
```
void setNotBefore(int notBefore)
```

isEventsEnabled
```
boolean isEventsEnabled()
```

setEventsEnabled

void setEventsEnabled(boolean enabled)

getEventsExpiration
```
long getEventsExpiration()
```

setEventsExpiration

void setEventsExpiration(long expiration)

getEventsListeners
```
@Deprecated
default Set<String> getEventsListeners()
```
Deprecated. Use getEventsListenersStream instead.

getEventsListenersStream
```
Stream<String> getEventsListenersStream()
```
Returns events listeners as a stream.

Returns:

Stream of String. Never returns null.

setEventsListeners

void setEventsListeners(Set<String> listeners)

getEnabledEventTypes
```
@Deprecated
default Set<String> getEnabledEventTypes()
```
Deprecated. Use getEnabledEventTypesStream instead.

getEnabledEventTypesStream
```
Stream<String> getEnabledEventTypesStream()
```
Returns enabled event types as a stream.

Returns:

Stream of String. Never returns null.

setEnabledEventTypes

void setEnabledEventTypes(Set<String> enabledEventTypes)

isAdminEventsEnabled
```
boolean isAdminEventsEnabled()
```

setAdminEventsEnabled

void setAdminEventsEnabled(boolean enabled)

isAdminEventsDetailsEnabled
```
boolean isAdminEventsDetailsEnabled()
```

setAdminEventsDetailsEnabled

void setAdminEventsDetailsEnabled(boolean enabled)

getMasterAdminClient
```
ClientModel getMasterAdminClient()
```

setMasterAdminClient

void setMasterAdminClient(ClientModel client)

getDefaultRole
```
RoleModel getDefaultRole()
```
Returns default realm role. All both realm and client default roles are assigned as composite of this role.

Returns:

Default role of this realm

setDefaultRole
```
void setDefaultRole(RoleModel role)
```
Sets default role for this realm

Parameters:

role - to be set

isIdentityFederationEnabled
```
boolean isIdentityFederationEnabled()
```

isInternationalizationEnabled

boolean isInternationalizationEnabled()

setInternationalizationEnabled

void setInternationalizationEnabled(boolean enabled)

getSupportedLocales
```
@Deprecated
default Set<String> getSupportedLocales()
```
Deprecated. Use getSupportedLocalesStream instead.

getSupportedLocalesStream
```
Stream<String> getSupportedLocalesStream()
```
Returns supported locales as a stream.

Returns:

Stream of String. Never returns null.

setSupportedLocales

void setSupportedLocales(Set<String> locales)

getDefaultLocale
```
String getDefaultLocale()
```

setDefaultLocale
```
void setDefaultLocale(String locale)
```

createGroup

default GroupModel createGroup(String name)

createGroup

default GroupModel createGroup(String id,
                               String name)

createGroup

default GroupModel createGroup(String name,
                               GroupModel toParent)

createGroup

GroupModel createGroup(String id,
                       String name,
                       GroupModel toParent)

getGroupById
```
GroupModel getGroupById(String id)
```

getGroups

@Deprecated
default List<GroupModel> getGroups()

Deprecated. Use getGroupsStream instead.

getGroupsStream
```
Stream<GroupModel> getGroupsStream()
```
Returns groups as a stream.

Returns:

Stream of GroupModel. Never returns null.

getGroupsCount

Long getGroupsCount(Boolean onlyTopGroups)

getGroupsCountByNameContaining

Long getGroupsCountByNameContaining(String search)

getTopLevelGroups

@Deprecated
default List<GroupModel> getTopLevelGroups()

Deprecated. Use getTopLevelGroups instead.

getTopLevelGroupsStream
```
Stream<GroupModel> getTopLevelGroupsStream()
```
Returns top level groups as a stream.

Returns:

Stream of GroupModel. Never returns null.

getTopLevelGroups

@Deprecated
default List<GroupModel> getTopLevelGroups(Integer first,
                                                       Integer max)

Deprecated. Use getTopLevelGroupsStream instead.

getTopLevelGroupsStream
```
Stream<GroupModel> getTopLevelGroupsStream(Integer first,
                                           Integer max)
```
Returns top level groups as a stream.

Parameters:

first - Integer Index of the first desired group. Ignored if negative or null.

max - Integer Maximum number of returned groups. Ignored if negative or null.

Returns:

Stream of GroupModel. Never returns null.

searchForGroupByName

@Deprecated
default List<GroupModel> searchForGroupByName(String search,
                                                          Integer first,
                                                          Integer max)

Deprecated. Use searchForGroupByName instead.

searchForGroupByNameStream
```
Stream<GroupModel> searchForGroupByNameStream(String search,
                                              Integer first,
                                              Integer max)
```
Searches for groups by provided name. Results that match the given filter are returned as a stream.

Parameters:

search - String Name of a group to be used as a filter.

first - Integer Index of the first desired group. Ignored if negative or null.

max - Integer Maximum number of returned groups. Ignored if negative or null.

Returns:

Stream of GroupModel. Never returns null.

removeGroup
```
boolean removeGroup(GroupModel group)
```

moveGroup

void moveGroup(GroupModel group,
               GroupModel toParent)

getClientScopes

@Deprecated
default List<ClientScopeModel> getClientScopes()

Deprecated. Use getClientScopesStream instead.

getClientScopesStream
```
Stream<ClientScopeModel> getClientScopesStream()
```
Returns all client scopes of this realm as a stream.

Returns:

Stream of ClientScopeModel. Never returns null.

addClientScope
```
ClientScopeModel addClientScope(String name)
```
Creates new client scope with the given name. Internal ID is created automatically. If given name contains spaces, those are replaced by underscores.

Parameters:

name - String name of the client scope.

Returns:

Model of the created client scope.

Throws:

ModelDuplicateException - if client scope with same id or name already exists.

addClientScope
```
ClientScopeModel addClientScope(String id,
                                String name)
```
Creates new client scope with the given internal ID and name. If given name contains spaces, those are replaced by underscores.

Parameters:

id - String id of the client scope.

name - String name of the client scope.

Returns:

Model of the created client scope.

Throws:

ModelDuplicateException - if client scope with same id or name already exists.

removeClientScope
```
boolean removeClientScope(String id)
```
Removes client scope with given id from this realm.

Parameters:

id - of the client scope

Returns:

true if the realm contained the scope and the removal was successful, false otherwise

getClientScopeById
```
ClientScopeModel getClientScopeById(String id)
```
Parameters:

id - of the client scope

Returns:

Client scope with the given id, or null when the scope does not exist.

addDefaultClientScope
```
void addDefaultClientScope(ClientScopeModel clientScope,
                           boolean defaultScope)
```
Adds given client scope among default/optional client scopes of this realm. The scope will be assigned to each new client.

Parameters:

clientScope - to be added

defaultScope - if true the scope will be added among default client scopes, if false it will be added among optional client scopes

removeDefaultClientScope
```
void removeDefaultClientScope(ClientScopeModel clientScope)
```
Removes given client scope from default or optional client scopes of this realm.

Parameters:

clientScope - to be removed

patchRealmLocalizationTexts
```
void patchRealmLocalizationTexts(String locale,
                                 Map<String,String> localizationTexts)
```
Patches the realm-specific localization texts. This method will not delete any text. It updates texts, which are already stored or create new ones if the key does not exist yet.

removeRealmLocalizationTexts

boolean removeRealmLocalizationTexts(String locale)

getRealmLocalizationTexts

Map<String,Map<String,String>> getRealmLocalizationTexts()

getRealmLocalizationTextsByLocale

Map<String,String> getRealmLocalizationTextsByLocale(String locale)

getDefaultClientScopes

@Deprecated
default List<ClientScopeModel> getDefaultClientScopes(boolean defaultScope)

Deprecated. Use getDefaultClientScopesStream instead.

getDefaultClientScopesStream
```
Stream<ClientScopeModel> getDefaultClientScopesStream(boolean defaultScope)
```
Returns default client scopes of this realm either default ones or optional ones.

Parameters:

defaultScope - if true default client scopes are returned, if false optional client scopes are returned.

Returns:

Stream of ClientScopeModel. Never returns null.

addToDefaultRoles
```
default void addToDefaultRoles(RoleModel role)
```
Adds a role as a composite to default role of this realm.

Parameters:

role - to be added

createClientInitialAccessModel

ClientInitialAccessModel createClientInitialAccessModel(int expiration,
                                                        int count)

getClientInitialAccessModel

ClientInitialAccessModel getClientInitialAccessModel(String id)

removeClientInitialAccessModel

void removeClientInitialAccessModel(String id)

getClientInitialAccesses

Stream<ClientInitialAccessModel> getClientInitialAccesses()

decreaseRemainingCount

void decreaseRemainingCount(ClientInitialAccessModel clientInitialAccess)

Interface RealmModel

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel

Field Summary

Method Summary

Methods inherited from interface org.keycloak.models.RoleContainerModel

Field Detail

COMPARE_BY_NAME

Method Detail

getId

getName

setName

getDisplayName

setDisplayName

getDisplayNameHtml

setDisplayNameHtml

isEnabled

setEnabled

getSslRequired

setSslRequired

isRegistrationAllowed

setRegistrationAllowed

isRegistrationEmailAsUsername

setRegistrationEmailAsUsername

isRememberMe

setRememberMe

isEditUsernameAllowed

setEditUsernameAllowed

isUserManagedAccessAllowed

setUserManagedAccessAllowed

setAttribute

setAttribute

setAttribute

setAttribute

removeAttribute

getAttribute

getAttribute

getAttribute

getAttribute

getAttributes

isBruteForceProtected

setBruteForceProtected

isPermanentLockout

setPermanentLockout

getMaxFailureWaitSeconds

setMaxFailureWaitSeconds

getWaitIncrementSeconds

setWaitIncrementSeconds

getMinimumQuickLoginWaitSeconds

setMinimumQuickLoginWaitSeconds

getQuickLoginCheckMilliSeconds

setQuickLoginCheckMilliSeconds

getMaxDeltaTimeSeconds

setMaxDeltaTimeSeconds

getFailureFactor

setFailureFactor

isVerifyEmail

setVerifyEmail

isLoginWithEmailAllowed

setLoginWithEmailAllowed

isDuplicateEmailsAllowed

setDuplicateEmailsAllowed

isResetPasswordAllowed

setResetPasswordAllowed

getDefaultSignatureAlgorithm

setDefaultSignatureAlgorithm

isRevokeRefreshToken

setRevokeRefreshToken

getRefreshTokenMaxReuse

setRefreshTokenMaxReuse

getSsoSessionIdleTimeout

setSsoSessionIdleTimeout

getSsoSessionMaxLifespan

setSsoSessionMaxLifespan

getSsoSessionIdleTimeoutRememberMe

setSsoSessionIdleTimeoutRememberMe

getSsoSessionMaxLifespanRememberMe

setSsoSessionMaxLifespanRememberMe

getOfflineSessionIdleTimeout

setOfflineSessionIdleTimeout