Package org.keycloak.models
Interface RealmModel
- 
- All Superinterfaces:
- RoleContainerModel
 - All Known Subinterfaces:
- CachedRealmModel,- LegacyRealmModel
 - All Known Implementing Classes:
- AbstractRealmModel,- MapRealmAdapter,- RealmAdapter,- RealmAdapter
 
 public interface RealmModel extends RoleContainerModel - Version:
- $Revision: 1 $
- Author:
- Bill Burke
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static interfaceRealmModel.IdentityProviderRemovedEventstatic interfaceRealmModel.IdentityProviderUpdatedEventstatic interfaceRealmModel.RealmCreationEventstatic interfaceRealmModel.RealmPostCreateEventstatic interfaceRealmModel.RealmRemovedEventstatic classRealmModel.SearchableFields- 
Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModelRoleContainerModel.RoleRemovedEvent
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static Comparator<RealmModel>COMPARE_BY_NAME
 - 
Method Summary- 
Methods inherited from interface org.keycloak.models.RoleContainerModeladdDefaultRole, addRole, addRole, getDefaultRoles, getDefaultRolesStream, getRole, getRolesStream, getRolesStream, removeDefaultRoles, removeRole, searchForRolesStream, updateDefaultRoles
 
- 
 
- 
- 
- 
Field Detail- 
COMPARE_BY_NAMEstatic final Comparator<RealmModel> COMPARE_BY_NAME 
 
- 
 - 
Method Detail- 
getIdString getId() - Specified by:
- getIdin interface- RoleContainerModel
 
 - 
getNameString getName() 
 - 
setNamevoid setName(String name) 
 - 
getDisplayNameString getDisplayName() 
 - 
setDisplayNamevoid setDisplayName(String displayName) 
 - 
getDisplayNameHtmlString getDisplayNameHtml() 
 - 
setDisplayNameHtmlvoid setDisplayNameHtml(String displayNameHtml) 
 - 
isEnabledboolean isEnabled() 
 - 
setEnabledvoid setEnabled(boolean enabled) 
 - 
getSslRequiredSslRequired getSslRequired() 
 - 
setSslRequiredvoid setSslRequired(SslRequired sslRequired) 
 - 
isRegistrationAllowedboolean isRegistrationAllowed() 
 - 
setRegistrationAllowedvoid setRegistrationAllowed(boolean registrationAllowed) 
 - 
isRegistrationEmailAsUsernameboolean isRegistrationEmailAsUsername() 
 - 
setRegistrationEmailAsUsernamevoid setRegistrationEmailAsUsername(boolean registrationEmailAsUsername) 
 - 
isRememberMeboolean isRememberMe() 
 - 
setRememberMevoid setRememberMe(boolean rememberMe) 
 - 
isEditUsernameAllowedboolean isEditUsernameAllowed() 
 - 
setEditUsernameAllowedvoid setEditUsernameAllowed(boolean editUsernameAllowed) 
 - 
isUserManagedAccessAllowedboolean isUserManagedAccessAllowed() 
 - 
setUserManagedAccessAllowedvoid setUserManagedAccessAllowed(boolean userManagedAccessAllowed) 
 - 
removeAttributevoid removeAttribute(String name) 
 - 
isBruteForceProtectedboolean isBruteForceProtected() 
 - 
setBruteForceProtectedvoid setBruteForceProtected(boolean value) 
 - 
isPermanentLockoutboolean isPermanentLockout() 
 - 
setPermanentLockoutvoid setPermanentLockout(boolean val) 
 - 
getMaxFailureWaitSecondsint getMaxFailureWaitSeconds() 
 - 
setMaxFailureWaitSecondsvoid setMaxFailureWaitSeconds(int val) 
 - 
getWaitIncrementSecondsint getWaitIncrementSeconds() 
 - 
setWaitIncrementSecondsvoid setWaitIncrementSeconds(int val) 
 - 
getMinimumQuickLoginWaitSecondsint getMinimumQuickLoginWaitSeconds() 
 - 
setMinimumQuickLoginWaitSecondsvoid setMinimumQuickLoginWaitSeconds(int val) 
 - 
getQuickLoginCheckMilliSecondslong getQuickLoginCheckMilliSeconds() 
 - 
setQuickLoginCheckMilliSecondsvoid setQuickLoginCheckMilliSeconds(long val) 
 - 
getMaxDeltaTimeSecondsint getMaxDeltaTimeSeconds() 
 - 
setMaxDeltaTimeSecondsvoid setMaxDeltaTimeSeconds(int val) 
 - 
getFailureFactorint getFailureFactor() 
 - 
setFailureFactorvoid setFailureFactor(int failureFactor) 
 - 
isVerifyEmailboolean isVerifyEmail() 
 - 
setVerifyEmailvoid setVerifyEmail(boolean verifyEmail) 
 - 
isLoginWithEmailAllowedboolean isLoginWithEmailAllowed() 
 - 
setLoginWithEmailAllowedvoid setLoginWithEmailAllowed(boolean loginWithEmailAllowed) 
 - 
isDuplicateEmailsAllowedboolean isDuplicateEmailsAllowed() 
 - 
setDuplicateEmailsAllowedvoid setDuplicateEmailsAllowed(boolean duplicateEmailsAllowed) 
 - 
isResetPasswordAllowedboolean isResetPasswordAllowed() 
 - 
setResetPasswordAllowedvoid setResetPasswordAllowed(boolean resetPasswordAllowed) 
 - 
getDefaultSignatureAlgorithmString getDefaultSignatureAlgorithm() 
 - 
setDefaultSignatureAlgorithmvoid setDefaultSignatureAlgorithm(String defaultSignatureAlgorithm) 
 - 
isRevokeRefreshTokenboolean isRevokeRefreshToken() 
 - 
setRevokeRefreshTokenvoid setRevokeRefreshToken(boolean revokeRefreshToken) 
 - 
getRefreshTokenMaxReuseint getRefreshTokenMaxReuse() 
 - 
setRefreshTokenMaxReusevoid setRefreshTokenMaxReuse(int revokeRefreshTokenCount) 
 - 
getSsoSessionIdleTimeoutint getSsoSessionIdleTimeout() 
 - 
setSsoSessionIdleTimeoutvoid setSsoSessionIdleTimeout(int seconds) 
 - 
getSsoSessionMaxLifespanint getSsoSessionMaxLifespan() 
 - 
setSsoSessionMaxLifespanvoid setSsoSessionMaxLifespan(int seconds) 
 - 
getSsoSessionIdleTimeoutRememberMeint getSsoSessionIdleTimeoutRememberMe() 
 - 
setSsoSessionIdleTimeoutRememberMevoid setSsoSessionIdleTimeoutRememberMe(int seconds) 
 - 
getSsoSessionMaxLifespanRememberMeint getSsoSessionMaxLifespanRememberMe() 
 - 
setSsoSessionMaxLifespanRememberMevoid setSsoSessionMaxLifespanRememberMe(int seconds) 
 - 
getOfflineSessionIdleTimeoutint getOfflineSessionIdleTimeout() 
 - 
setOfflineSessionIdleTimeoutvoid setOfflineSessionIdleTimeout(int seconds) 
 - 
getAccessTokenLifespanint getAccessTokenLifespan() 
 - 
isOfflineSessionMaxLifespanEnabledboolean isOfflineSessionMaxLifespanEnabled() 
 - 
setOfflineSessionMaxLifespanEnabledvoid setOfflineSessionMaxLifespanEnabled(boolean offlineSessionMaxLifespanEnabled) 
 - 
getOfflineSessionMaxLifespanint getOfflineSessionMaxLifespan() 
 - 
setOfflineSessionMaxLifespanvoid setOfflineSessionMaxLifespan(int seconds) 
 - 
getClientSessionIdleTimeoutint getClientSessionIdleTimeout() 
 - 
setClientSessionIdleTimeoutvoid setClientSessionIdleTimeout(int seconds) 
 - 
getClientSessionMaxLifespanint getClientSessionMaxLifespan() 
 - 
setClientSessionMaxLifespanvoid setClientSessionMaxLifespan(int seconds) 
 - 
getClientOfflineSessionIdleTimeoutint getClientOfflineSessionIdleTimeout() 
 - 
setClientOfflineSessionIdleTimeoutvoid setClientOfflineSessionIdleTimeout(int seconds) 
 - 
getClientOfflineSessionMaxLifespanint getClientOfflineSessionMaxLifespan() 
 - 
setClientOfflineSessionMaxLifespanvoid setClientOfflineSessionMaxLifespan(int seconds) 
 - 
setAccessTokenLifespanvoid setAccessTokenLifespan(int seconds) 
 - 
getAccessTokenLifespanForImplicitFlowint getAccessTokenLifespanForImplicitFlow() 
 - 
setAccessTokenLifespanForImplicitFlowvoid setAccessTokenLifespanForImplicitFlow(int seconds) 
 - 
getAccessCodeLifespanint getAccessCodeLifespan() 
 - 
setAccessCodeLifespanvoid setAccessCodeLifespan(int seconds) 
 - 
getAccessCodeLifespanUserActionint getAccessCodeLifespanUserAction() 
 - 
setAccessCodeLifespanUserActionvoid setAccessCodeLifespanUserAction(int seconds) 
 - 
getOAuth2DeviceConfigOAuth2DeviceConfig getOAuth2DeviceConfig() 
 - 
getCibaPolicyCibaConfig getCibaPolicy() 
 - 
getParPolicyParConfig getParPolicy() 
 - 
getUserActionTokenLifespansMap<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
 
 - 
getAccessCodeLifespanLoginint getAccessCodeLifespanLogin() 
 - 
setAccessCodeLifespanLoginvoid setAccessCodeLifespanLogin(int seconds) 
 - 
getActionTokenGeneratedByAdminLifespanint getActionTokenGeneratedByAdminLifespan() 
 - 
setActionTokenGeneratedByAdminLifespanvoid setActionTokenGeneratedByAdminLifespan(int seconds) 
 - 
getActionTokenGeneratedByUserLifespanint getActionTokenGeneratedByUserLifespan() 
 - 
setActionTokenGeneratedByUserLifespanvoid setActionTokenGeneratedByUserLifespan(int seconds) 
 - 
getActionTokenGeneratedByUserLifespanint getActionTokenGeneratedByUserLifespan(String actionTokenType) 
 - 
setActionTokenGeneratedByUserLifespanvoid setActionTokenGeneratedByUserLifespan(String actionTokenType, Integer seconds) 
 - 
getRequiredCredentialsStreamStream<RequiredCredentialModel> getRequiredCredentialsStream() Returns required credentials as a stream.- Returns:
- Stream of RequiredCredentialModel. Never returnsnull.
 
 - 
addRequiredCredentialvoid addRequiredCredential(String cred) 
 - 
getPasswordPolicyPasswordPolicy getPasswordPolicy() 
 - 
setPasswordPolicyvoid setPasswordPolicy(PasswordPolicy policy) 
 - 
getOTPPolicyOTPPolicy getOTPPolicy() 
 - 
setOTPPolicyvoid setOTPPolicy(OTPPolicy policy) 
 - 
getWebAuthnPolicyWebAuthnPolicy getWebAuthnPolicy() - Returns:
- WebAuthn policy for 2-factor authentication
 
 - 
setWebAuthnPolicyvoid setWebAuthnPolicy(WebAuthnPolicy policy) Set WebAuthn policy for 2-factor authentication- Parameters:
- policy-
 
 - 
getWebAuthnPolicyPasswordlessWebAuthnPolicy getWebAuthnPolicyPasswordless() - Returns:
- WebAuthn passwordless policy below. This is temporary and will be removed later.
 
 - 
setWebAuthnPolicyPasswordlessvoid setWebAuthnPolicyPasswordless(WebAuthnPolicy policy) Set WebAuthn passwordless policy below. This is temporary and will be removed later.- Parameters:
- policy-
 
 - 
getDefaultGroupsStreamStream<GroupModel> getDefaultGroupsStream() Returns default groups as a stream.- Returns:
- Stream of GroupModel. Never returnsnull.
 
 - 
addDefaultGroupvoid addDefaultGroup(GroupModel group) 
 - 
removeDefaultGroupvoid removeDefaultGroup(GroupModel group) 
 - 
getClientsStreamStream<ClientModel> getClientsStream() Returns clients as a stream.- Returns:
- Stream of ClientModel. Never returnsnull.
 
 - 
getClientsStreamStream<ClientModel> getClientsStream(Integer firstResult, Integer maxResults) Returns clients as a stream.- Parameters:
- firstResult-- IntegerIndex of the first desired client. Ignored if negative or- null.
- maxResults-- IntegerMaximum number of returned clients. Ignored if negative or- null.
- Returns:
- Stream of ClientModel. Never returnsnull.
 
 - 
getClientsCountLong getClientsCount() 
 - 
getAlwaysDisplayInConsoleClientsStreamStream<ClientModel> getAlwaysDisplayInConsoleClientsStream() Returns clients which are always displayed in the admin console as a stream.- Returns:
- Stream of ClientModel. Never returnsnull.
 
 - 
addClientClientModel addClient(String name) 
 - 
addClientClientModel addClient(String id, String clientId) 
 - 
removeClientboolean removeClient(String id) 
 - 
getClientByIdClientModel getClientById(String id) 
 - 
getClientByClientIdClientModel getClientByClientId(String clientId) 
 - 
searchClientByClientIdStreamStream<ClientModel> searchClientByClientIdStream(String clientId, Integer firstResult, Integer maxResults) Search for clients by provided client's id.- Parameters:
- clientId-- StringId 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 returnsnull.
 
 - 
searchClientByAttributesStream<ClientModel> searchClientByAttributes(Map<String,String> attributes, Integer firstResult, Integer maxResults) 
 - 
getBrowserFlowAuthenticationFlowModel getBrowserFlow() 
 - 
setBrowserFlowvoid setBrowserFlow(AuthenticationFlowModel flow) 
 - 
getRegistrationFlowAuthenticationFlowModel getRegistrationFlow() 
 - 
setRegistrationFlowvoid setRegistrationFlow(AuthenticationFlowModel flow) 
 - 
getDirectGrantFlowAuthenticationFlowModel getDirectGrantFlow() 
 - 
setDirectGrantFlowvoid setDirectGrantFlow(AuthenticationFlowModel flow) 
 - 
getResetCredentialsFlowAuthenticationFlowModel getResetCredentialsFlow() 
 - 
setResetCredentialsFlowvoid setResetCredentialsFlow(AuthenticationFlowModel flow) 
 - 
getClientAuthenticationFlowAuthenticationFlowModel getClientAuthenticationFlow() 
 - 
setClientAuthenticationFlowvoid setClientAuthenticationFlow(AuthenticationFlowModel flow) 
 - 
getDockerAuthenticationFlowAuthenticationFlowModel getDockerAuthenticationFlow() 
 - 
setDockerAuthenticationFlowvoid setDockerAuthenticationFlow(AuthenticationFlowModel flow) 
 - 
getAuthenticationFlowsStreamStream<AuthenticationFlowModel> getAuthenticationFlowsStream() Returns authentications flows as a stream.- Returns:
- Stream of AuthenticationFlowModel. Never returnsnull.
 
 - 
getFlowByAliasAuthenticationFlowModel getFlowByAlias(String alias) 
 - 
addAuthenticationFlowAuthenticationFlowModel addAuthenticationFlow(AuthenticationFlowModel model) 
 - 
getAuthenticationFlowByIdAuthenticationFlowModel getAuthenticationFlowById(String id) 
 - 
removeAuthenticationFlowvoid removeAuthenticationFlow(AuthenticationFlowModel model) 
 - 
updateAuthenticationFlowvoid updateAuthenticationFlow(AuthenticationFlowModel model) 
 - 
getAuthenticationExecutionsStreamStream<AuthenticationExecutionModel> getAuthenticationExecutionsStream(String flowId) Returns sorted (according to priority)AuthenticationExecutionModelas a stream. It should be used with forEachOrdered if the ordering is required.- Parameters:
- flowId-- StringId of the flow.
- Returns:
- Sorted stream of AuthenticationExecutionModel. Never returnsnull.
 
 - 
getAuthenticationExecutionByIdAuthenticationExecutionModel getAuthenticationExecutionById(String id) 
 - 
getAuthenticationExecutionByFlowIdAuthenticationExecutionModel getAuthenticationExecutionByFlowId(String flowId) 
 - 
addAuthenticatorExecutionAuthenticationExecutionModel addAuthenticatorExecution(AuthenticationExecutionModel model) 
 - 
updateAuthenticatorExecutionvoid updateAuthenticatorExecution(AuthenticationExecutionModel model) 
 - 
removeAuthenticatorExecutionvoid removeAuthenticatorExecution(AuthenticationExecutionModel model) 
 - 
getAuthenticatorConfigsStreamStream<AuthenticatorConfigModel> getAuthenticatorConfigsStream() Returns authentication configs as a stream.- Returns:
- Stream of AuthenticatorConfigModel. Never returnsnull.
 
 - 
addAuthenticatorConfigAuthenticatorConfigModel addAuthenticatorConfig(AuthenticatorConfigModel model) 
 - 
updateAuthenticatorConfigvoid updateAuthenticatorConfig(AuthenticatorConfigModel model) 
 - 
removeAuthenticatorConfigvoid removeAuthenticatorConfig(AuthenticatorConfigModel model) 
 - 
getAuthenticatorConfigByIdAuthenticatorConfigModel getAuthenticatorConfigById(String id) 
 - 
getAuthenticatorConfigByAliasAuthenticatorConfigModel getAuthenticatorConfigByAlias(String alias) 
 - 
getRequiredActionProvidersStreamStream<RequiredActionProviderModel> getRequiredActionProvidersStream() Returns sortedRequiredActionProviderModelas a stream. It should be used with forEachOrdered if the ordering is required.- Returns:
- Sorted stream of RequiredActionProviderModel. Never returnsnull.
 
 - 
addRequiredActionProviderRequiredActionProviderModel addRequiredActionProvider(RequiredActionProviderModel model) 
 - 
updateRequiredActionProvidervoid updateRequiredActionProvider(RequiredActionProviderModel model) 
 - 
removeRequiredActionProvidervoid removeRequiredActionProvider(RequiredActionProviderModel model) 
 - 
getRequiredActionProviderByIdRequiredActionProviderModel getRequiredActionProviderById(String id) 
 - 
getRequiredActionProviderByAliasRequiredActionProviderModel getRequiredActionProviderByAlias(String alias) 
 - 
getIdentityProvidersStreamStream<IdentityProviderModel> getIdentityProvidersStream() Returns identity providers as a stream.- Returns:
- Stream of IdentityProviderModel. Never returnsnull.
 
 - 
getIdentityProviderByAliasIdentityProviderModel getIdentityProviderByAlias(String alias) 
 - 
addIdentityProvidervoid addIdentityProvider(IdentityProviderModel identityProvider) 
 - 
removeIdentityProviderByAliasvoid removeIdentityProviderByAlias(String alias) 
 - 
updateIdentityProvidervoid updateIdentityProvider(IdentityProviderModel identityProvider) 
 - 
getIdentityProviderMappersStreamStream<IdentityProviderMapperModel> getIdentityProviderMappersStream() Returns identity provider mappers as a stream.- Returns:
- Stream of IdentityProviderMapperModel. Never returnsnull.
 
 - 
getIdentityProviderMappersByAliasStreamStream<IdentityProviderMapperModel> getIdentityProviderMappersByAliasStream(String brokerAlias) Returns identity provider mappers by the provided alias as a stream.- Parameters:
- brokerAlias-- StringBroker's alias to filter results.
- Returns:
- Stream of IdentityProviderMapperModelNever returnsnull.
 
 - 
addIdentityProviderMapperIdentityProviderMapperModel addIdentityProviderMapper(IdentityProviderMapperModel model) 
 - 
removeIdentityProviderMappervoid removeIdentityProviderMapper(IdentityProviderMapperModel mapping) 
 - 
updateIdentityProviderMappervoid updateIdentityProviderMapper(IdentityProviderMapperModel mapping) 
 - 
getIdentityProviderMapperByIdIdentityProviderMapperModel getIdentityProviderMapperById(String id) 
 - 
getIdentityProviderMapperByNameIdentityProviderMapperModel getIdentityProviderMapperByName(String brokerAlias, String name) 
 - 
addComponentModelComponentModel addComponentModel(ComponentModel model) Adds component model. Will call onCreate() method of ComponentFactory- Parameters:
- model-
- Returns:
 
 - 
importComponentModelComponentModel importComponentModel(ComponentModel model) Adds component model. Will NOT call onCreate() method of ComponentFactory- Parameters:
- model-
- Returns:
 
 - 
updateComponentvoid updateComponent(ComponentModel component) Updates component model. Will call onUpdate() method of ComponentFactory- Parameters:
- component- to be updated
 
 - 
removeComponentvoid removeComponent(ComponentModel component) Removes given component. Will call preRemove() method of ComponentFactory. Also callsthis.removeComponents(component.getId()).- Parameters:
- component- to be removed
 
 - 
removeComponentsvoid removeComponents(String parentId) Removes all components with givenparentId- Parameters:
- parentId-- Stringid of parent
 
 - 
getComponentsStreamStream<ComponentModel> getComponentsStream(String parentId, String providerType) Returns stream of ComponentModels for specific parentId and providerType.- Parameters:
- parentId-- Stringid of parent
- providerType-- Stringtype of provider
- Returns:
- Stream of ComponentModel. Never returnsnull.
 
 - 
getComponentsStreamStream<ComponentModel> getComponentsStream(String parentId) Returns stream of ComponentModels for specific parentId.- Parameters:
- parentId-- Stringid of parent
- Returns:
- Stream of ComponentModel. Never returnsnull.
 
 - 
getComponentsStreamStream<ComponentModel> getComponentsStream() Returns stream of component models.- Returns:
- Stream of ComponentModel. Never returnsnull.
 
 - 
getComponentComponentModel getComponent(String id) 
 - 
getStorageProvidersdefault 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 returnsnull.
 
 - 
getLoginThemeString getLoginTheme() 
 - 
setLoginThemevoid setLoginTheme(String name) 
 - 
getAccountThemeString getAccountTheme() 
 - 
setAccountThemevoid setAccountTheme(String name) 
 - 
getAdminThemeString getAdminTheme() 
 - 
setAdminThemevoid setAdminTheme(String name) 
 - 
getEmailThemeString getEmailTheme() 
 - 
setEmailThemevoid setEmailTheme(String name) 
 - 
getNotBeforeint getNotBefore() Time in seconds since epoc- Returns:
 
 - 
setNotBeforevoid setNotBefore(int notBefore) 
 - 
isEventsEnabledboolean isEventsEnabled() 
 - 
setEventsEnabledvoid setEventsEnabled(boolean enabled) 
 - 
getEventsExpirationlong getEventsExpiration() 
 - 
setEventsExpirationvoid setEventsExpiration(long expiration) 
 - 
getEventsListenersStreamStream<String> getEventsListenersStream() Returns events listeners as a stream.- Returns:
- Stream of String. Never returnsnull.
 
 - 
getEnabledEventTypesStreamStream<String> getEnabledEventTypesStream() Returns enabled event types as a stream.- Returns:
- Stream of String. Never returnsnull.
 
 - 
isAdminEventsEnabledboolean isAdminEventsEnabled() 
 - 
setAdminEventsEnabledvoid setAdminEventsEnabled(boolean enabled) 
 - 
isAdminEventsDetailsEnabledboolean isAdminEventsDetailsEnabled() 
 - 
setAdminEventsDetailsEnabledvoid setAdminEventsDetailsEnabled(boolean enabled) 
 - 
getMasterAdminClientClientModel getMasterAdminClient() 
 - 
setMasterAdminClientvoid setMasterAdminClient(ClientModel client) 
 - 
getDefaultRoleRoleModel 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
 
 - 
setDefaultRolevoid setDefaultRole(RoleModel role) Sets default role for this realm- Parameters:
- role- to be set
 
 - 
isIdentityFederationEnabledboolean isIdentityFederationEnabled() 
 - 
isInternationalizationEnabledboolean isInternationalizationEnabled() 
 - 
setInternationalizationEnabledvoid setInternationalizationEnabled(boolean enabled) 
 - 
getSupportedLocalesStreamStream<String> getSupportedLocalesStream() Returns supported locales as a stream.- Returns:
- Stream of String. Never returnsnull.
 
 - 
getDefaultLocaleString getDefaultLocale() 
 - 
setDefaultLocalevoid setDefaultLocale(String locale) 
 - 
createGroupdefault GroupModel createGroup(String name) 
 - 
createGroupdefault GroupModel createGroup(String id, String name) 
 - 
createGroupdefault GroupModel createGroup(String name, GroupModel toParent) 
 - 
createGroupGroupModel createGroup(String id, String name, GroupModel toParent) 
 - 
getGroupByIdGroupModel getGroupById(String id) 
 - 
getGroupsStreamStream<GroupModel> getGroupsStream() Returns groups as a stream.- Returns:
- Stream of GroupModel. Never returnsnull.
 
 - 
getTopLevelGroupsStreamStream<GroupModel> getTopLevelGroupsStream() Returns top level groups as a stream.- Returns:
- Stream of GroupModel. Never returnsnull.
 
 - 
getTopLevelGroupsStreamStream<GroupModel> getTopLevelGroupsStream(Integer first, Integer max) Returns top level groups as a stream.- Parameters:
- first-- IntegerIndex of the first desired group. Ignored if negative or- null.
- max-- IntegerMaximum number of returned groups. Ignored if negative or- null.
- Returns:
- Stream of GroupModel. Never returnsnull.
 
 - 
searchForGroupByNameStream@Deprecated Stream<GroupModel> searchForGroupByNameStream(String search, Integer first, Integer max) Deprecated.Searches for groups by provided name. Results that match the given filter are returned as a stream.- Parameters:
- search-- StringName of a group to be used as a filter.
- first-- IntegerIndex of the first desired group. Ignored if negative or- null.
- max-- IntegerMaximum number of returned groups. Ignored if negative or- null.
- Returns:
- Stream of GroupModel. Never returnsnull.
 
 - 
removeGroupboolean removeGroup(GroupModel group) 
 - 
moveGroupvoid moveGroup(GroupModel group, GroupModel toParent) 
 - 
getClientScopesStreamStream<ClientScopeModel> getClientScopesStream() Returns all client scopes of this realm as a stream.- Returns:
- Stream of ClientScopeModel. Never returnsnull.
 
 - 
addClientScopeClientScopeModel 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-- Stringname of the client scope.
- Returns:
- Model of the created client scope.
- Throws:
- ModelDuplicateException- if client scope with same id or name already exists.
 
 - 
addClientScopeClientScopeModel 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-- Stringid of the client scope.
- name-- Stringname of the client scope.
- Returns:
- Model of the created client scope.
- Throws:
- ModelDuplicateException- if client scope with same id or name already exists.
 
 - 
removeClientScopeboolean removeClientScope(String id) Removes client scope with givenidfrom this realm.- Parameters:
- id- of the client scope
- Returns:
- true if the realm contained the scope and the removal was successful, false otherwise
 
 - 
getClientScopeByIdClientScopeModel getClientScopeById(String id) - Parameters:
- id- of the client scope
- Returns:
- Client scope with the given id, ornullwhen the scope does not exist.
 
 - 
addDefaultClientScopevoid 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- truethe scope will be added among default client scopes, if- falseit will be added among optional client scopes
 
 - 
removeDefaultClientScopevoid removeDefaultClientScope(ClientScopeModel clientScope) Removes given client scope from default or optional client scopes of this realm.- Parameters:
- clientScope- to be removed
 
 - 
createOrUpdateRealmLocalizationTextsvoid createOrUpdateRealmLocalizationTexts(String locale, Map<String,String> localizationTexts) Creates or updates the realm-specific localization texts for the given locale. 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.
 - 
removeRealmLocalizationTextsboolean removeRealmLocalizationTexts(String locale) 
 - 
getRealmLocalizationTextsByLocaleMap<String,String> getRealmLocalizationTextsByLocale(String locale) 
 - 
getDefaultClientScopesStreamStream<ClientScopeModel> getDefaultClientScopesStream(boolean defaultScope) Returns default client scopes of this realm either default ones or optional ones.- Parameters:
- defaultScope- if- truedefault client scopes are returned, if- falseoptional client scopes are returned.
- Returns:
- Stream of ClientScopeModel. Never returnsnull.
 
 - 
addToDefaultRolesdefault void addToDefaultRoles(RoleModel role) Adds a role as a composite to default role of this realm.- Parameters:
- role- to be added
 
 - 
createClientInitialAccessModelClientInitialAccessModel createClientInitialAccessModel(int expiration, int count) 
 - 
getClientInitialAccessModelClientInitialAccessModel getClientInitialAccessModel(String id) 
 - 
removeClientInitialAccessModelvoid removeClientInitialAccessModel(String id) 
 - 
getClientInitialAccessesStream<ClientInitialAccessModel> getClientInitialAccesses() 
 - 
decreaseRemainingCountvoid decreaseRemainingCount(ClientInitialAccessModel clientInitialAccess) 
 
- 
 
-