8000 Ensure organization id is preserved on export/import by sguilhen · Pull Request #33244 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ public static String cacheKeyOrgMemberCount(RealmModel realm, OrganizationModel
}

@Override
public OrganizationModel create(String name, String alias) {
public OrganizationModel create(String id, String name, String alias) {
registerCountInvalidation();
return orgDelegate.create(name, alias);
return orgDelegate.create(id, name, alias);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import org.keycloak.models.jpa.entities.OrganizationEntity;
import org.keycloak.models.jpa.entities.UserEntity;
import org.keycloak.models.jpa.entities.UserGroupMembershipEntity;
import org.keycloak.models.utils.KeycloakModelUtils;
import org.keycloak.organization.OrganizationProvider;
import org.keycloak.representations.idm.MembershipType;
import org.keycloak.organization.utils.Organizations;
Expand All @@ -76,7 +77,7 @@ public JpaOrganizationProvider(KeycloakSession session) {
}

@Override
public OrganizationModel create(String name, String alias) {
public OrganizationModel create(String id, String name, String alias) {
if (StringUtil.isBlank(name)) {
throw new ModelValidationException("Name can not be null");
}
Expand All @@ -98,8 +99,10 @@ public OrganizationModel create(String name, String alias) {
throw new ModelDuplicateException("A organization with the same alias already exists");
}

RealmModel realm = getRealm();
OrganizationAdapter adapter = new OrganizationAdapter(session, realm, this);
OrganizationEntity entity = new OrganizationEntity();
entity.setId(id != null ? id : KeycloakModelUtils.generateId());
entity.setRealmId(getRealm().getId());
OrganizationAdapter adapter = new OrganizationAdapter(session, getRealm(), entity, this);

try {
session.getContext().setOrganization(adapter);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,6 @@ public final class OrganizationAdapter implements OrganizationModel, JpaModel<Or
private GroupModel group;
private Map<String, List<String>> attributes;

public OrganizationAdapter(KeycloakSession session, RealmModel realm, OrganizationProvider provider) {
this.session = session;
entity = new OrganizationEntity();
entity.setId(KeycloakModelUtils.generateId());
entity.setRealmId(realm.getId());
this.realm = realm;
this.provider = provider;
}

public OrganizationAdapter(KeycloakSession session, RealmModel realm, OrganizationEntity entity, OrganizationProvider provider) {
this.session = session;
this.realm = realm;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
List<RoleRepresentation> currentAppRoleReps = exportRoles(currentAppRoles);
clientRolesReps.put(client.getClientId(), currentAppRoleReps);
}
if (clientRolesReps.size() > 0) {
if (!clientRolesReps.isEmpty()) {
rolesRep.setClient(clientRolesReps);
}
}
Expand All @@ -156,11 +156,7 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
} else {
ClientModel app = (ClientModel) scope.getContainer();
String appName = app.getClientId();
List<ScopeMappingRepresentation> currentAppScopes = clientScopeReps.get(appName);
if (currentAppScopes == null) {
currentAppScopes = new ArrayList<>();
clientScopeReps.put(appName, currentAppScopes);
}
List<ScopeMappingRepresentation> currentAppScopes = clientScopeReps.computeIfAbsent(appName, k -> new ArrayList<>());

ScopeMappingRepresentation currentClientScope = null;
for (ScopeMappingRepresentation scopeMapping : currentAppScopes) {
Expand Down Expand Up @@ -193,11 +189,7 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
} else {
ClientModel app = (ClientModel)scope.getContainer();
String appName = app.getClientId();
List<ScopeMappingRepresentation> currentAppScopes = clientScopeReps.get(appName);
if (currentAppScopes == null) {
currentAppScopes = new ArrayList<>();
clientScopeReps.put(appName, currentAppScopes);
}
List<ScopeMappingRepresentation> currentAppScopes = clientScopeReps.computeIfAbsent(appName, k -> new ArrayList<>());

ScopeMappingRepresentation currentClientTemplateScope = null;
for (ScopeMappingRepresentation scopeMapping : currentAppScopes) {
Expand All @@ -216,7 +208,7 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
}
});

if (clientScopeReps.size() > 0) {
if (!clientScopeReps.isEmpty()) {
rep.setClientScopeMappings(clientScopeReps);
}

Expand All @@ -226,15 +218,15 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
.map(user -> exportUser(session, realm, user, options, internal))
.collect(Collectors.toList());

if (users.size() > 0) {
if (!users.isEmpty()) {
rep.setUsers(users);
}

UserFederatedStorageProvider userFederatedStorageProvider = userFederatedStorage(session);
if (userFederatedStorageProvider != null) {
List<UserRepresentation> federatedUsers = userFederatedStorage(session).getStoredUsersStream(realm, 0, -1)
.map(user -> exportFederatedUser(session, realm, user, options)).collect(Collectors.toList());
if (federatedUsers.size() > 0) {
if (!federatedUsers.isEmpty()) {
rep.setFederatedUsers(federatedUsers);
}
}
Expand All @@ -251,7 +243,7 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode
}
}

if (users.size() > 0) {
if (!users.isEmpty()) {
rep.setUsers(users);
}
}
Expand All @@ -265,32 +257,19 @@ public static RealmRepresentation exportRealm(KeycloakSession session, RealmMode

if (Profile.isFeatureEnabled(Feature.ORGANIZATION) && !options.isPartial()) {
OrganizationProvider orgProvider = session.getProvider(OrganizationProvider.class);
orgProvider.getAllStream().map(m -> {
OrganizationRepresentation org = new OrganizationRepresentation();

org.setName(m.getName());
org.setAlias(m.getAlias());
org.setEnabled(m.isEnabled());
org.setDescription(m.getDescription());
m.getDomains().map(d -> {
OrganizationDomainRepresentation domain = new OrganizationDomainRepresentation();

domain.setName(d.getName());
domain.setVerified(d.isVerified());

return domain;
}).forEach(org::addDomain);
orgProvider.getAllStream().map(model -> {
OrganizationRepresentation org = ModelToRepresentation.toRepresentation(model);

orgProvider.getMembersStream(m, null, null, null, null)
orgProvider.getMembersStream(model, null, null, null, null)
.forEach(user -> {
MemberRepresentation member = new MemberRepresentation();
member.setUsername(user.getUsername());
member.setMembershipType(orgProvider.isManagedMember(m, user) ? MembershipType.MANAGED : MembershipType.UNMANAGED);
member.setMembershipType(orgProvider.isManagedMember(model, user) ? MembershipType.MANAGED : MembershipType.UNMANAGED);

org.addMember(member);
});

orgProvider.getIdentityProviders(m)
orgProvider.getIdentityProviders(model)
.map(b -> {
IdentityProviderRepresentation broker = new IdentityProviderRepresentation();
broker.setAlias(b.getAlias());
Expand Down
10BC8
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
import org.keycloak.models.ModelException;
import org.keycloak.models.OAuth2DeviceConfig;
import org.keycloak.models.OTPPolicy;
import org.keycloak.models.OrganizationDomainModel;
import org.keycloak.models.OrganizationModel;
import org.keycloak.models.ParConfig;
import org.keycloak.models.PasswordPolicy;
Expand Down Expand Up @@ -1590,21 +1589,20 @@ private void importOrganizations(RealmRepresentation rep, RealmModel newRealm) {
OrganizationProvider provider = session.getProvider(OrganizationProvider.class);

for (OrganizationRepresentation orgRep : Optional.ofNullable(rep.getOrganizations()).orElse(Collections.emptyList())) {
OrganizationModel org = provider.create(orgRep.getName(), orgRep.getAlias());

org.setDomains(orgRep.getDomains().stream().map(r -> new OrganizationDomainModel(r.getName(), r.isVerified())).collect(Collectors.toSet()));
OrganizationModel orgModel = provider.create(orgRep.getId(), orgRep.getName(), orgRep.getAlias());
RepresentationToModel.toModel(orgRep, orgModel);

for (IdentityProviderRepresentation identityProvider : Optional.ofNullable(orgRep.getIdentityProviders()).orElse(Collections.emptyList())) {
IdentityProviderModel idp = session.identityProviders().getByAlias(identityProvider.getAlias());
provider.addIdentityProvider(org, idp);
provider.addIdentityProvider(orgModel, idp);
}

for (MemberRepresentation member : Optional.ofNullable(orgRep.getMembers()).orElse(Collections.emptyList())) {
UserModel m = session.users().getUserByUsername(newRealm, member.getUsername());
if (MembershipType.MANAGED.equals(member.getMembershipType())) {
provider.addManagedMember(org, m);
provider.addManagedMember(orgModel, m);
} else {
provider.addMember(org, m);
provider.addMember(orgModel, m);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1291,4 +1291,35 @@ public static RequiredActionConfigRepresentation toRepresentation(RequiredAction
rep.setConfig(model.getConfig());
return rep;
}

public static OrganizationRepresentation toRepresentation(OrganizationModel model) {
OrganizationRepresentation rep = toBriefRepresentation(model);
if (rep == null) {
return null;
}
rep.setAttributes(model.getAttributes());
return rep;
}

public static OrganizationRepresentation toBriefRepresentation(OrganizationModel model) {
if (model == null) {
return null;
}
OrganizationRepresentation rep = new OrganizationRepresentation();
rep.setId(model.getId());
rep.setName(model.getName());
rep.setAlias(model.getAlias());
rep.setEnabled(model.isEnabled());
rep.setDescription(model.getDescription());
model.getDomains().filter(Objects::nonNull).map(ModelToRepresentation::toRepresentation)
.forEach(rep::addDomain);
return rep;
}

public static OrganizationDomainRepresentation toRepresentation(OrganizationDomainModel model) {
OrganizationDomainRepresentation representation = new OrganizationDomainRepresentation();
representation.setName(model.getName());
representation.setVerified(model.isVerified());
return representation;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@
import org.keycloak.representations.idm.GroupRepresentation;
import org.keycloak.representations.idm.IdentityProviderMapperRepresentation;
import org.keycloak.representations.idm.IdentityProviderRepresentation;
import org.keycloak.representations.idm.OrganizationDomainRepresentation;
10BC8 import org.keycloak.representations.idm.OrganizationRepresentation;
import org.keycloak.representations.idm.ProtocolMapperRepresentation;
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.representations.idm.RoleRepresentation;
Expand All @@ -127,6 +129,7 @@
import org.keycloak.util.JsonSerialization;
import org.keycloak.utils.StringUtil;

import static java.util.Optional.ofNullable;
import static org.keycloak.protocol.saml.util.ArtifactBindingUtils.computeArtifactBindingIdentifierString;

public class RepresentationToModel {
Expand Down Expand Up @@ -1674,4 +1677,27 @@ private static void updateOrganizationBroker(IdentityProviderRepresentation repr
representation.setOrganizationId(orgId);
}
}

public static OrganizationModel toModel(OrganizationRepresentation rep, OrganizationModel model) {
if (rep == null) {
return null;
}

model.setName(rep.getName());
model.setAlias(rep.getAlias());
model.setEnabled(rep.isEnabled());
model.setDescription(rep.getDescription());
model.setAttributes(rep.getAttributes());
model.setDomains(ofNullable(rep.getDomains()).orElse(Set.of()).stream()
.filter(Objects::nonNull)
.filter(domain -> StringUtil.isNotBlank(domain.getName()))
.map(RepresentationToModel::toModel)
.collect(Collectors.toSet()));

return model;
}

public static OrganizationDomainModel toModel(OrganizationDomainRepresentation domainRepresentation) {
return new OrganizationDomainModel(domainRepresentation.getName(), domainRepresentation.isVerified());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,26 @@
public interface OrganizationProvider extends Provider {

/**
* Creates a new organization with given {@code name} to the realm.
* Creates a new organization with given {@code name} and {@code alias} to the realm.
* The internal ID of the organization will be created automatically.
* @param name String name of the organization.
* @param name the name of the organization.
* @param alias the alias of the organization. If not set, defaults to the value set to {@code name}. Once set, the alias is immutable.
* @throws ModelDuplicateException If there is already an organization with the given name or alias
* @return Model of the created organization.
*/
OrganizationModel create(String name, String alias);
default OrganizationModel create(String name, String alias) {
return create(null, name, alias);
}

/**
* Creates a new organization with given {@code id}, {@code name}, and {@code alias} to the realm
* @param id the id of the organization.
* @param name the name of the organization.
* @param alias the alias of the organization. If not set, defaults to the value set to {@code name}. Once set, the alias is immutable.
* @throws ModelDuplicateException If there is already an organization with the given name or alias
* @return Model of the created organization.
*/
OrganizationModel create(String id, String name, String alias);

/**
* Returns a {@link OrganizationModel} by its {@code id};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

package org.keycloak.organization.admin.resource;

import java.util.List;
import java.util.stream.Stream;

import jakarta.ws.rs.Consumes;
Expand Down Expand Up @@ -49,11 +48,9 @@

import org.keycloak.models.utils.ModelToRepresentation;
import org.keycloak.organization.OrganizationProvider;
import org.keycloak.organization.utils.Organizations;
import org.keycloak.representations.idm.MemberRepresentation;
import org.keycloak.representations.idm.MembershipType;
import org.keycloak.representations.idm.OrganizationRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.services.ErrorResponse;
import org.keycloak.services.resources.KeycloakOpenAPI;
import org.keycloak.services.resources.admin.AdminEventBuilder;
Expand Down Expand Up @@ -193,7 +190,7 @@ public Stream<OrganizationRepresentation> getOrganizations(@PathParam("id") Stri

UserModel member = getUser(id);

return provider.getByMember(member).map(Organizations::toRepresentation);
return provider.getByMember(member).map(ModelToRepresentation::toRepresentation);
}

@Path("count")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.ModelValidationException;
import org.keycloak.models.OrganizationModel;
import org.keycloak.models.utils.ModelToRepresentation;
import org.keycloak.models.utils.RepresentationToModel;
import org.keycloak.organization.OrganizationProvider;
import org.keycloak.organization.utils.Organizations;
import org.keycloak.representations.idm.OrganizationRepresentation;
import org.keycloak.services.ErrorResponse;
import org.keycloak.services.resources.KeycloakOpenAPI;
Expand Down Expand Up @@ -67,7 +68,7 @@ public OrganizationResource(KeycloakSession session, OrganizationModel organizat
@Tag(name = KeycloakOpenAPI.Admin.Tags.ORGANIZATIONS)
@Operation(summary = "Returns the organization representation")
public OrganizationRepresentation get() {
return Organizations.toRepresentation(organization);
return ModelToRepresentation.toRepresentation(organization);
}

@DELETE
Expand All @@ -84,7 +85,7 @@ public Response delete() {
@Operation(summary = "Updates the organization")
public Response update(OrganizationRepresentation organizationRep) {
try {
Organizations.toModel(organizationRep, organization);
RepresentationToModel.toModel(organizationRep, organization);
return Response.noContent().build();
} catch (ModelValidationException mve) {
throw ErrorResponse.error(mve.getMessage(), Response.Status.BAD_REQUEST);
Expand Down
Loading
0