## Uses of Class
org.keycloak.representations.idm.RealmRepresentation

- Packages that use RealmRepresentation
  Package | Description
  --- | ---
  org.keycloak.admin.client.resource |
  org.keycloak.exportimport.dir |
  org.keycloak.exportimport.singlefile |
  org.keycloak.exportimport.util |
  org.keycloak.migration |
  org.keycloak.migration.migrators |
  org.keycloak.models.utils |
  org.keycloak.representations.idm |
  org.keycloak.services.clientpolicy |
  org.keycloak.services.managers |
  org.keycloak.services.resources |
  org.keycloak.services.resources.admin |

- - ### Uses of RealmRepresentation in org.keycloak.admin.client.resource

    Methods in org.keycloak.admin.client.resource that return RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `RealmRepresentation` | RealmResource.`partialExport(Boolean exportGroupsAndRoles, Boolean exportClients)`
    `RealmRepresentation` | RealmResource.`toRepresentation()`

    Methods in org.keycloak.admin.client.resource that return types with arguments of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `List<RealmRepresentation>` | RealmsResource.`findAll()`

    Methods in org.keycloak.admin.client.resource with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | RealmsResource.`create(RealmRepresentation realmRepresentation)`
    `void` | RealmResource.`update(RealmRepresentation realmRepresentation)`

  - ### Uses of RealmRepresentation in org.keycloak.exportimport.dir

    Methods in org.keycloak.exportimport.dir with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | DirExportProvider.`writeRealm(String fileName, RealmRepresentation rep)`

  - ### Uses of RealmRepresentation in org.keycloak.exportimport.singlefile

    Fields in org.keycloak.exportimport.singlefile with type parameters of type RealmRepresentation
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,RealmRepresentation>` | SingleFileImportProvider.`realmReps`

  - ### Uses of RealmRepresentation in org.keycloak.exportimport.util

    Methods in org.keycloak.exportimport.util that return RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static RealmRepresentation` | ExportUtils.`exportRealm(KeycloakSession session, RealmModel realm, boolean includeUsers, boolean internal)`
    `static RealmRepresentation` | ExportUtils.`exportRealm(KeycloakSession session, RealmModel realm, ExportOptions options, boolean internal)`

    Methods in org.keycloak.exportimport.util that return types with arguments of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static Map<String,RealmRepresentation>` | ImportUtils.`getRealmsFromStream(com.fasterxml.jackson.databind.ObjectMapper mapper, InputStream is)`

    Methods in org.keycloak.exportimport.util with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | ImportUtils.`importRealm(KeycloakSession session, RealmRepresentation rep, Strategy strategy, boolean skipUserDependent)` Fully import realm from representation, save it to model and return model of newly created realm
    `protected abstract void` | MultipleStepsExportProvider.`writeRealm(String fileName, RealmRepresentation rep)`

    Method parameters in org.keycloak.exportimport.util with type arguments of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | ImportUtils.`importRealms(KeycloakSession session, Collection<RealmRepresentation> realms, Strategy strategy)`

  - ### Uses of RealmRepresentation in org.keycloak.migration

    Methods in org.keycloak.migration with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | MigrationModelManager.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`

  - ### Uses of RealmRepresentation in org.keycloak.migration.migrators

    Methods in org.keycloak.migration.migrators with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `default void` | Migration.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)` Called after full import of representation.
    `void` | MigrateTo9_0_4.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo9_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo8_0_2.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo8_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo6_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo4_6_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo4_2_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo4_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_4_2.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_4_1.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_4_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_2_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_1_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo3_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo2_5_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo2_3_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo2_2_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo2_1_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo2_0_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_9_2.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_8_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_7_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_6_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_5_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_4_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_3_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`
    `void` | MigrateTo1_2_0.`migrateImport(KeycloakSession session, RealmModel realm, RealmRepresentation rep, boolean skipUserDependent)`

  - ### Uses of RealmRepresentation in org.keycloak.models.utils

    Methods in org.keycloak.models.utils that return RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static RealmRepresentation` | StripSecretsUtils.`strip(RealmRepresentation rep)`
    `static RealmRepresentation` | StripSecretsUtils.`stripForExport(KeycloakSession session, RealmRepresentation rep)`
    `static RealmRepresentation` | ModelToRepresentation.`toRepresentation(RealmModel realm, boolean internal)`

    Methods in org.keycloak.models.utils with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | ModelToRepresentation.`exportAuthenticationFlows(RealmModel realm, RealmRepresentation rep)`
    `static void` | ModelToRepresentation.`exportGroups(RealmModel realm, RealmRepresentation rep)`
    `static void` | ModelToRepresentation.`exportRequiredActions(RealmModel realm, RealmRepresentation rep)`
    `static Map<String,String>` | RepresentationToModel.`importAuthenticationFlows(RealmModel newRealm, RealmRepresentation rep)`
    `static void` | RepresentationToModel.`importGroups(RealmModel realm, RealmRepresentation rep)`
    `static void` | RepresentationToModel.`importRealm(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm, boolean skipUserDependent)`
    `static void` | RepresentationToModel.`importRealmAuthorizationSettings(RealmRepresentation rep, RealmModel newRealm, KeycloakSession session)`
    `static void` | RepresentationToModel.`importUserFederationProvidersAndMappers(KeycloakSession session, RealmRepresentation rep, RealmModel newRealm)`
    `static RealmRepresentation` | StripSecretsUtils.`strip(RealmRepresentation rep)`
    `static RealmRepresentation` | StripSecretsUtils.`stripForExport(KeycloakSession session, RealmRepresentation rep)`
    `static OTPPolicy` | RepresentationToModel.`toPolicy(RealmRepresentation rep)`
    `static void` | RepresentationToModel.`updateRealm(RealmRepresentation rep, RealmModel realm, KeycloakSession session)`

  - ### Uses of RealmRepresentation in org.keycloak.representations.idm

    Methods in org.keycloak.representations.idm that return RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `RealmRepresentation` | RealmRepresentation.`setDockerAuthenticationFlow(String dockerAuthenticationFlow)`

  - ### Uses of RealmRepresentation in org.keycloak.services.clientpolicy

    Methods in org.keycloak.services.clientpolicy with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientPolicyManager.`setupClientPoliciesOnExportingRealm(RealmModel realm, RealmRepresentation rep)` when exporting realm the realm, prepares the exported representation of the client profiles and policies.
    `void` | DefaultClientPolicyManager.`setupClientPoliciesOnExportingRealm(RealmModel realm, RealmRepresentation rep)`
    `void` | ClientPolicyManager.`setupClientPoliciesOnImportedRealm(RealmModel realm, RealmRepresentation rep)` when importing a realm, reads the builtin client profiles and policies that have already been set on keycloak application on booting keycloak and override them with ones loaded from the imported realm json file.
    `void` | DefaultClientPolicyManager.`setupClientPoliciesOnImportedRealm(RealmModel realm, RealmRepresentation rep)`

  - ### Uses of RealmRepresentation in org.keycloak.services.managers

    Methods in org.keycloak.services.managers with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `String` | RealmManager.`getRealmAdminClientId(RealmRepresentation realm)`
    `RealmModel` | RealmManager.`importRealm(RealmRepresentation rep)`
    `RealmModel` | RealmManager.`importRealm(RealmRepresentation rep, boolean skipUserDependent)` if "skipUserDependent" is true, then import of any models, which needs users already imported in DB, will be skipped.
    `void` | RealmManager.`setupClientServiceAccountsAndAuthorizationOnImport(RealmRepresentation rep, boolean skipUserDependent)`

  - ### Uses of RealmRepresentation in org.keycloak.services.resources

    Methods in org.keycloak.services.resources with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | KeycloakApplication.`importRealm(RealmRepresentation rep, String from)`

  - ### Uses of RealmRepresentation in org.keycloak.services.resources.admin

    Methods in org.keycloak.services.resources.admin that return RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `RealmRepresentation` | RealmAdminResource.`getRealm()` Get the top-level representation of the realm It will not include nested information like User and Client representations.
    `RealmRepresentation` | RealmAdminResource.`partialExport(Boolean exportGroupsAndRoles, Boolean exportClients)` Partial export of existing realm into a JSON file.
    `protected RealmRepresentation` | RealmsAdminResource.`toRealmRep(RealmModel realm)`

    Methods in org.keycloak.services.resources.admin that return types with arguments of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `Stream<RealmRepresentation>` | RealmsAdminResource.`getRealms()` Get accessible realms Returns a list of accessible realms.

    Methods in org.keycloak.services.resources.admin with parameters of type RealmRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | RealmsAdminResource.`importRealm(RealmRepresentation rep)` Import a realm Imports a realm from a full representation of that realm.
    `javax.ws.rs.core.Response` | RealmAdminResource.`updateRealm(RealmRepresentation rep)` Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.

Copyright © 2021 JBoss by Red Hat. All rights reserved.