RealmResource (Red Hat Single Sign-On CD 7 public API)

```
public interface RealmResource
```
Author:

rodrigo.sasaki@icarros.com.br

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addDefaultDefaultClientScope(String clientScopeId)`
`void`	`addDefaultGroup(String groupId)`
`void`	`addDefaultOptionalClientScope(String clientScopeId)`
`AttackDetectionResource`	`attackDetection()`
`void`	`clearAdminEvents()`
`void`	`clearEvents()`
`void`	`clearKeysCache()`
`void`	`clearRealmCache()`
`void`	`clearUserCache()`
`ClientInitialAccessResource`	`clientInitialAccess()`
`ClientRegistrationPolicyResource`	`clientRegistrationPolicy()`
`ClientsResource`	`clients()`
`ClientScopesResource`	`clientScopes()`
`ComponentsResource`	`components()`
`ClientRepresentation`	`convertClientDescription(String description)`
`void`	`deleteSession(String sessionId)`
`AuthenticationManagementResource`	`flows()`
`List<AdminEventRepresentation>`	`getAdminEvents()`
`List<AdminEventRepresentation>`	`getAdminEvents(List<String> operationTypes, String authRealm, String authClient, String authUser, String authIpAddress, String resourcePath, String dateFrom, String dateTo, Integer firstResult, Integer maxResults)`
`List<Map<String,String>>`	`getClientSessionStats()`
`List<ClientScopeRepresentation>`	`getDefaultDefaultClientScopes()`
`List<GroupRepresentation>`	`getDefaultGroups()`
`List<ClientScopeRepresentation>`	`getDefaultOptionalClientScopes()`
`List<EventRepresentation>`	`getEvents()`
`List<EventRepresentation>`	`getEvents(List<String> types, String client, String user, String dateFrom, String dateTo, String ipAddress, Integer firstResult, Integer maxResults)`
`GroupRepresentation`	`getGroupByPath(String path)`
`RealmEventsConfigRepresentation`	`getRealmEventsConfig()`
`GroupsResource`	`groups()`
`IdentityProvidersResource`	`identityProviders()`
`KeyResource`	`keys()`
`GlobalRequestResult`	`logoutAll()`
`RealmRepresentation`	`partialExport(Boolean exportGroupsAndRoles, Boolean exportClients)`
`Response`	`partialImport(PartialImportRepresentation rep)`
`GlobalRequestResult`	`pushRevocation()`
`void`	`remove()`
`void`	`removeDefaultDefaultClientScope(String clientScopeId)`
`void`	`removeDefaultGroup(String groupId)`
`void`	`removeDefaultOptionalClientScope(String clientScopeId)`
`RolesResource`	`roles()`
`RoleByIdResource`	`rolesById()`
`Response`	`testLDAPConnection(String action, String connectionUrl, String bindDn, String bindCredential, String useTruststoreSpi, String connectionTimeout)`
`Response`	`testSMTPConnection(String config)`
`RealmRepresentation`	`toRepresentation()`
`void`	`update(RealmRepresentation realmRepresentation)`
`void`	`updateRealmEventsConfig(RealmEventsConfigRepresentation rep)`
`UsersResource`	`users()`
`UserStorageProviderResource`	`userStorage()`

Method Detail

toRepresentation
```
RealmRepresentation toRepresentation()
```

update

void update(RealmRepresentation realmRepresentation)

clients
```
ClientsResource clients()
```

clientScopes
```
ClientScopesResource clientScopes()
```

getDefaultDefaultClientScopes

List<ClientScopeRepresentation> getDefaultDefaultClientScopes()

addDefaultDefaultClientScope

void addDefaultDefaultClientScope(String clientScopeId)

removeDefaultDefaultClientScope

void removeDefaultDefaultClientScope(String clientScopeId)

getDefaultOptionalClientScopes

List<ClientScopeRepresentation> getDefaultOptionalClientScopes()

addDefaultOptionalClientScope

void addDefaultOptionalClientScope(String clientScopeId)

removeDefaultOptionalClientScope

void removeDefaultOptionalClientScope(String clientScopeId)

convertClientDescription

ClientRepresentation convertClientDescription(String description)

users
```
UsersResource users()
```

roles
```
RolesResource roles()
```

rolesById
```
RoleByIdResource rolesById()
```

groups
```
GroupsResource groups()
```

clearEvents
```
void clearEvents()
```

getEvents
```
List<EventRepresentation> getEvents()
```

getEvents

List<EventRepresentation> getEvents(List<String> types,
                                    String client,
                                    String user,
                                    String dateFrom,
                                    String dateTo,
                                    String ipAddress,
                                    Integer firstResult,
                                    Integer maxResults)

clearAdminEvents
```
void clearAdminEvents()
```

getAdminEvents

List<AdminEventRepresentation> getAdminEvents()

getAdminEvents

List<AdminEventRepresentation> getAdminEvents(List<String> operationTypes,
                                              String authRealm,
                                              String authClient,
                                              String authUser,
                                              String authIpAddress,
                                              String resourcePath,
                                              String dateFrom,
                                              String dateTo,
                                              Integer firstResult,
                                              Integer maxResults)

getRealmEventsConfig

RealmEventsConfigRepresentation getRealmEventsConfig()

updateRealmEventsConfig

void updateRealmEventsConfig(RealmEventsConfigRepresentation rep)

getGroupByPath

GroupRepresentation getGroupByPath(String path)

getDefaultGroups

List<GroupRepresentation> getDefaultGroups()

addDefaultGroup
```
void addDefaultGroup(String groupId)
```

removeDefaultGroup

void removeDefaultGroup(String groupId)

identityProviders

IdentityProvidersResource identityProviders()

remove
```
void remove()
```

getClientSessionStats

List<Map<String,String>> getClientSessionStats()

clientInitialAccess

ClientInitialAccessResource clientInitialAccess()

clientRegistrationPolicy

ClientRegistrationPolicyResource clientRegistrationPolicy()

partialImport

Response partialImport(PartialImportRepresentation rep)

partialExport

RealmRepresentation partialExport(Boolean exportGroupsAndRoles,
                                  Boolean exportClients)

flows

AuthenticationManagementResource flows()

attackDetection

AttackDetectionResource attackDetection()

testLDAPConnection

Response testLDAPConnection(String action,
                            String connectionUrl,
                            String bindDn,
                            String bindCredential,
                            String useTruststoreSpi,
                            String connectionTimeout)

testSMTPConnection

Response testSMTPConnection(String config)
                     throws Exception

Throws:: Exception

clearRealmCache
```
void clearRealmCache()
```

clearUserCache
```
void clearUserCache()
```

clearKeysCache
```
void clearKeysCache()
```

pushRevocation
```
GlobalRequestResult pushRevocation()
```

logoutAll
```
GlobalRequestResult logoutAll()
```

deleteSession
```
void deleteSession(String sessionId)
```

components
```
ComponentsResource components()
```

userStorage

UserStorageProviderResource userStorage()

keys
```
KeyResource keys()
```

Interface RealmResource

Method Summary

Method Detail

toRepresentation

update

clients

clientScopes

getDefaultDefaultClientScopes

addDefaultDefaultClientScope

removeDefaultDefaultClientScope

getDefaultOptionalClientScopes

addDefaultOptionalClientScope

removeDefaultOptionalClientScope

convertClientDescription

users

roles

rolesById

groups

clearEvents

getEvents

getEvents

clearAdminEvents

getAdminEvents

getAdminEvents

getRealmEventsConfig

updateRealmEventsConfig

getGroupByPath

getDefaultGroups

addDefaultGroup

removeDefaultGroup

identityProviders

remove

getClientSessionStats

clientInitialAccess

clientRegistrationPolicy

partialImport

partialExport

flows

attackDetection

testLDAPConnection

testSMTPConnection

clearRealmCache

clearUserCache

clearKeysCache

pushRevocation

logoutAll

deleteSession

components

userStorage

keys