Skip to content

Fix SAML v2 API: null/omitted string attributes now remove model attributes #51252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −5
Draft

Fix SAML v2 API: null/omitted string attributes now remove model attributes #51252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a910d45
Initial plan
Copilot Jul 28, 2026
be285d9
Fix SAML null attribute removal in SAMLClientModelMapper
Copilot Jul 28, 2026
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
4 changes: 4 additions & 0 deletions rest/admin-v2/services/src/main/java/org/keycloak/models/mapper/SAMLClientModelMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,16 @@ private Boolean getBooleanAttribute(ClientModel model, String key) {
private void setAttributeIfNotNull(ClientModel model, String key, String value) {
if (value != null) {
model.setAttribute(key, value);
} else {
model.removeAttribute(key);
}
}

private void setBooleanAttributeIfNotNull(ClientModel model, String key, Boolean value) {
if (value != null) {
model.setAttribute(key, value.toString());
} else {
model.removeAttribute(key);
}
}
}
12 changes: 7 additions & 5 deletions ...min-v2/tests/src/test/java/org/keycloak/tests/admin/mapper/SAMLClientModelMapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ public void toModel_setsEcpFlow(KeycloakSession session) {
}

@TestOnServer
public void toModel_doesNotSetNullAttributes(KeycloakSession session) {
public void toModel_removesAttributesWhenNull(KeycloakSession session) {
RealmModel realm = session.realms().getRealmByName("master");
session.getContext().setRealm(realm);

Expand All @@ -374,19 +374,21 @@ public void toModel_doesNotSetNullAttributes(KeycloakSession session) {
// Pre-set some attributes
clientModel.setAttribute(SAML_NAME_ID_FORMAT, "existing-format");
clientModel.setAttribute(SAML_SIGNATURE_ALGORITHM, "existing-algorithm");
clientModel.setAttribute(SAML_SIGNING_CERTIFICATE, "existing-cert");

SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("test-saml-tomodel-null");
rep.setRedirectUris(Set.of());
// Leave SAML-specific fields null
// Leave SAML-specific fields null (null means remove existing attribute)

SAMLClientModelMapper mapper = getModelMapper(session);
mapper.toModel(rep, clientModel);

// Existing attributes should remain unchanged when rep values are null
assertThat(clientModel.getAttribute(SAML_NAME_ID_FORMAT), is("existing-format"));
assertThat(clientModel.getAttribute(SAML_SIGNATURE_ALGORITHM), is("existing-algorithm"));
// Existing attributes should be removed when rep values are null
assertThat(clientModel.getAttribute(SAML_NAME_ID_FORMAT), nullValue());
assertThat(clientModel.getAttribute(SAML_SIGNATURE_ALGORITHM), nullValue());
assertThat(clientModel.getAttribute(SAML_SIGNING_CERTIFICATE), nullValue());
} finally {
realm.removeClient(clientModel.getId());
}
Expand Down
Loading