RealmModel (Red Hat Single Sign-On 7.3.0.CD03 public 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.ClientCreationEvent`
`static interface`	`RealmModel.ClientRemovedEvent`
`static interface`	`RealmModel.ClientUpdatedEvent`
`static interface`	`RealmModel.IdentityProviderRemovedEvent`
`static interface`	`RealmModel.IdentityProviderUpdatedEvent`
`static interface`	`RealmModel.RealmCreationEvent`
`static interface`	`RealmModel.RealmPostCreateEvent`
`static interface`	`RealmModel.RealmRemovedEvent`

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

Method Summary

All Methods Instance Methods Abstract Methods Default 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)`
`ClientScopeModel`	`addClientScope(String id, String name)`
`ComponentModel`	`addComponentModel(ComponentModel model)` Adds component model.
`void`	`addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)`
`void`	`addDefaultGroup(GroupModel group)`
`void`	`addIdentityProvider(IdentityProviderModel identityProvider)`
`IdentityProviderMapperModel`	`addIdentityProviderMapper(IdentityProviderMapperModel model)`
`RequiredActionProviderModel`	`addRequiredActionProvider(RequiredActionProviderModel model)`
`void`	`addRequiredCredential(String cred)`
`GroupModel`	`createGroup(String name)`
`GroupModel`	`createGroup(String id, String name)`
`int`	`getAccessCodeLifespan()`
`int`	`getAccessCodeLifespanLogin()`
`int`	`getAccessCodeLifespanUserAction()`
`int`	`getAccessTokenLifespan()`
`int`	`getAccessTokenLifespanForImplicitFlow()`
`String`	`getAccountTheme()`
`int`	`getActionTokenGeneratedByAdminLifespan()`
`int`	`getActionTokenGeneratedByUserLifespan()`
`int`	`getActionTokenGeneratedByUserLifespan(String actionTokenType)`
`String`	`getAdminTheme()`
`String`	`getAttribute(String name)`
`Boolean`	`getAttribute(String name, Boolean defaultValue)`
`Integer`	`getAttribute(String name, Integer defaultValue)`
`Long`	`getAttribute(String name, Long defaultValue)`
`Map<String,String>`	`getAttributes()`
`AuthenticationExecutionModel`	`getAuthenticationExecutionById(String id)`
`List<AuthenticationExecutionModel>`	`getAuthenticationExecutions(String flowId)`
`AuthenticationFlowModel`	`getAuthenticationFlowById(String id)`
`List<AuthenticationFlowModel>`	`getAuthenticationFlows()`
`AuthenticatorConfigModel`	`getAuthenticatorConfigByAlias(String alias)`
`AuthenticatorConfigModel`	`getAuthenticatorConfigById(String id)`
`List<AuthenticatorConfigModel>`	`getAuthenticatorConfigs()`
`AuthenticationFlowModel`	`getBrowserFlow()`
`Map<String,String>`	`getBrowserSecurityHeaders()`
`AuthenticationFlowModel`	`getClientAuthenticationFlow()`
`ClientModel`	`getClientByClientId(String clientId)`
`ClientModel`	`getClientById(String id)`
`List<ClientModel>`	`getClients()`
`ClientScopeModel`	`getClientScopeById(String id)`
`List<ClientScopeModel>`	`getClientScopes()`
`default List<ClientStorageProviderModel>`	`getClientStorageProviders()`
`ComponentModel`	`getComponent(String id)`
`List<ComponentModel>`	`getComponents()`
`List<ComponentModel>`	`getComponents(String parentId)`
`List<ComponentModel>`	`getComponents(String parentId, String providerType)`
`List<ClientScopeModel>`	`getDefaultClientScopes(boolean defaultScope)`
`List<GroupModel>`	`getDefaultGroups()`
`String`	`getDefaultLocale()`
`AuthenticationFlowModel`	`getDirectGrantFlow()`
`String`	`getDisplayName()`
`String`	`getDisplayNameHtml()`
`AuthenticationFlowModel`	`getDockerAuthenticationFlow()`
`String`	`getEmailTheme()`
`Set<String>`	`getEnabledEventTypes()`
`long`	`getEventsExpiration()`
`Set<String>`	`getEventsListeners()`
`int`	`getFailureFactor()`
`AuthenticationFlowModel`	`getFlowByAlias(String alias)`
`GroupModel`	`getGroupById(String id)`
`List<GroupModel>`	`getGroups()`
`Long`	`getGroupsCount(Boolean onlyTopGroups)`
`Long`	`getGroupsCountByNameContaining(String search)`
`String`	`getId()`
`IdentityProviderModel`	`getIdentityProviderByAlias(String alias)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperById(String id)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperByName(String brokerAlias, String name)`
`Set<IdentityProviderMapperModel>`	`getIdentityProviderMappers()`
`Set<IdentityProviderMapperModel>`	`getIdentityProviderMappersByAlias(String brokerAlias)`
`List<IdentityProviderModel>`	`getIdentityProviders()`
`String`	`getLoginTheme()`
`ClientModel`	`getMasterAdminClient()`
`int`	`getMaxDeltaTimeSeconds()`
`int`	`getMaxFailureWaitSeconds()`
`int`	`getMinimumQuickLoginWaitSeconds()`
`String`	`getName()`
`int`	`getNotBefore()` Time in seconds since epoc
`int`	`getOfflineSessionIdleTimeout()`
`int`	`getOfflineSessionMaxLifespan()`
`OTPPolicy`	`getOTPPolicy()`
`PasswordPolicy`	`getPasswordPolicy()`
`long`	`getQuickLoginCheckMilliSeconds()`
`int`	`getRefreshTokenMaxReuse()`
`AuthenticationFlowModel`	`getRegistrationFlow()`
`RequiredActionProviderModel`	`getRequiredActionProviderByAlias(String alias)`
`RequiredActionProviderModel`	`getRequiredActionProviderById(String id)`
`List<RequiredActionProviderModel>`	`getRequiredActionProviders()`
`List<RequiredCredentialModel>`	`getRequiredCredentials()`
`AuthenticationFlowModel`	`getResetCredentialsFlow()`
`RoleModel`	`getRoleById(String id)`
`Map<String,String>`	`getSmtpConfig()`
`SslRequired`	`getSslRequired()`
`int`	`getSsoSessionIdleTimeout()`
`int`	`getSsoSessionMaxLifespan()`
`Set<String>`	`getSupportedLocales()`
`List<GroupModel>`	`getTopLevelGroups()`
`List<GroupModel>`	`getTopLevelGroups(Integer first, Integer max)`
`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()`
`int`	`getWaitIncrementSeconds()`
`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`	`removeAttribute(String name)`
`void`	`removeAuthenticationFlow(AuthenticationFlowModel model)`
`void`	`removeAuthenticatorConfig(AuthenticatorConfigModel model)`
`void`	`removeAuthenticatorExecution(AuthenticationExecutionModel model)`
`boolean`	`removeClient(String id)`
`boolean`	`removeClientScope(String id)`
`void`	`removeComponent(ComponentModel component)`
`void`	`removeComponents(String parentId)`
`void`	`removeDefaultClientScope(ClientScopeModel clientScope)`
`void`	`removeDefaultGroup(GroupModel group)`
`boolean`	`removeGroup(GroupModel group)`
`void`	`removeIdentityProviderByAlias(String alias)`
`void`	`removeIdentityProviderMapper(IdentityProviderMapperModel mapping)`
`void`	`removeRequiredActionProvider(RequiredActionProviderModel model)`
`List<GroupModel>`	`searchForGroupByName(String search, Integer first, Integer max)`
`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)`
`void`	`setAttribute(String name, Boolean value)`
`void`	`setAttribute(String name, Integer value)`
`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`	`setDefaultLocale(String locale)`
`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(SslRequired sslRequired)`
`void`	`setSsoSessionIdleTimeout(int seconds)`
`void`	`setSsoSessionMaxLifespan(int seconds)`
`void`	`setSupportedLocales(Set<String> locales)`
`void`	`setUserManagedAccessAllowed(boolean userManagedAccessAllowed)`
`void`	`setVerifyEmail(boolean verifyEmail)`
`void`	`setWaitIncrementSeconds(int val)`
`void`	`updateAuthenticationFlow(AuthenticationFlowModel model)`
`void`	`updateAuthenticatorConfig(AuthenticatorConfigModel model)`
`void`	`updateAuthenticatorExecution(AuthenticationExecutionModel model)`
`void`	`updateComponent(ComponentModel component)`
`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, getRole, getRoles, removeDefaultRoles, removeRole, updateDefaultRoles

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
```
SslRequired getSslRequired()
```

setSslRequired

void setSslRequired(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

void setAttribute(String name,
                  Boolean value)

setAttribute

void setAttribute(String name,
                  Integer value)

setAttribute

void setAttribute(String name,
                  Long value)

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

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

getAttribute

Integer getAttribute(String name,
                     Integer defaultValue)

getAttribute

Long getAttribute(String name,
                  Long defaultValue)

getAttribute

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)

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)

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)

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)

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

List<RequiredCredentialModel> getRequiredCredentials()

addRequiredCredential

void addRequiredCredential(String cred)

getPasswordPolicy
```
PasswordPolicy getPasswordPolicy()
```

setPasswordPolicy

void setPasswordPolicy(PasswordPolicy policy)

getOTPPolicy
```
OTPPolicy getOTPPolicy()
```

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

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

getDefaultGroups
```
List<GroupModel> getDefaultGroups()
```

addDefaultGroup

void addDefaultGroup(GroupModel group)

removeDefaultGroup

void removeDefaultGroup(GroupModel group)

getClients
```
List<ClientModel> getClients()
```

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)

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

List<AuthenticationFlowModel> getAuthenticationFlows()

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

List<AuthenticationExecutionModel> getAuthenticationExecutions(String flowId)

getAuthenticationExecutionById

AuthenticationExecutionModel getAuthenticationExecutionById(String id)

addAuthenticatorExecution

AuthenticationExecutionModel addAuthenticatorExecution(AuthenticationExecutionModel model)

updateAuthenticatorExecution

void updateAuthenticatorExecution(AuthenticationExecutionModel model)

removeAuthenticatorExecution

void removeAuthenticatorExecution(AuthenticationExecutionModel model)

getAuthenticatorConfigs

List<AuthenticatorConfigModel> getAuthenticatorConfigs()

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

List<RequiredActionProviderModel> getRequiredActionProviders()

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

List<IdentityProviderModel> getIdentityProviders()

getIdentityProviderByAlias

IdentityProviderModel getIdentityProviderByAlias(String alias)

addIdentityProvider

void addIdentityProvider(IdentityProviderModel identityProvider)

removeIdentityProviderByAlias

void removeIdentityProviderByAlias(String alias)

updateIdentityProvider

void updateIdentityProvider(IdentityProviderModel identityProvider)

getIdentityProviderMappers

Set<IdentityProviderMapperModel> getIdentityProviderMappers()

getIdentityProviderMappersByAlias

Set<IdentityProviderMapperModel> getIdentityProviderMappersByAlias(String brokerAlias)

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)

removeComponent

void removeComponent(ComponentModel component)

removeComponents

void removeComponents(String parentId)

getComponents

List<ComponentModel> getComponents(String parentId,
                                   String providerType)

getComponents

List<ComponentModel> getComponents(String parentId)

getComponents
```
List<ComponentModel> getComponents()
```

getComponent

ComponentModel getComponent(String id)

getUserStorageProviders

default List<UserStorageProviderModel> getUserStorageProviders()

getClientStorageProviders

default List<ClientStorageProviderModel> getClientStorageProviders()

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
```
Set<String> getEventsListeners()
```

setEventsListeners

void setEventsListeners(Set<String> listeners)

getEnabledEventTypes
```
Set<String> getEnabledEventTypes()
```

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)

isIdentityFederationEnabled
```
boolean isIdentityFederationEnabled()
```

isInternationalizationEnabled

boolean isInternationalizationEnabled()

setInternationalizationEnabled

void setInternationalizationEnabled(boolean enabled)

getSupportedLocales
```
Set<String> getSupportedLocales()
```

setSupportedLocales

void setSupportedLocales(Set<String> locales)

getDefaultLocale
```
String getDefaultLocale()
```

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

createGroup
```
GroupModel createGroup(String name)
```

createGroup

GroupModel createGroup(String id,
                       String name)

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

getGroups
```
List<GroupModel> getGroups()
```

getGroupsCount

Long getGroupsCount(Boolean onlyTopGroups)

getGroupsCountByNameContaining

Long getGroupsCountByNameContaining(String search)

getTopLevelGroups
```
List<GroupModel> getTopLevelGroups()
```

getTopLevelGroups

List<GroupModel> getTopLevelGroups(Integer first,
                                   Integer max)

searchForGroupByName

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

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

moveGroup

void moveGroup(GroupModel group,
               GroupModel toParent)

getClientScopes

List<ClientScopeModel> getClientScopes()

addClientScope

ClientScopeModel addClientScope(String name)

addClientScope

ClientScopeModel addClientScope(String id,
                                String name)

removeClientScope
```
boolean removeClientScope(String id)
```

getClientScopeById

ClientScopeModel getClientScopeById(String id)

addDefaultClientScope

void addDefaultClientScope(ClientScopeModel clientScope,
                           boolean defaultScope)

removeDefaultClientScope

void removeDefaultClientScope(ClientScopeModel clientScope)

getDefaultClientScopes

List<ClientScopeModel> getDefaultClientScopes(boolean defaultScope)

Interface RealmModel

Nested Class Summary

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

Method Summary

Methods inherited from interface org.keycloak.models.RoleContainerModel

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

isRevokeRefreshToken

setRevokeRefreshToken

getRefreshTokenMaxReuse

setRefreshTokenMaxReuse

getSsoSessionIdleTimeout

setSsoSessionIdleTimeout

getSsoSessionMaxLifespan

setSsoSessionMaxLifespan

getOfflineSessionIdleTimeout

setOfflineSessionIdleTimeout

getAccessTokenLifespan

isOfflineSessionMaxLifespanEnabled

setOfflineSessionMaxLifespanEnabled

getOfflineSessionMaxLifespan

setOfflineSessionMaxLifespan

setAccessTokenLifespan

getAccessTokenLifespanForImplicitFlow

setAccessTokenLifespanForImplicitFlow

getAccessCodeLifespan