Skip to content

Removing deprecated EntityDescriptorClientRegistrationProvider Client Registration Provider - #55101

Open
PadzerButch wants to merge 1 commit into
keycloak:mainfrom
PadzerButch:EOL_53478_EntityDescriptorClientRegistrationProvider
Open

PadzerButch wants to merge 1 commit into
keycloak:mainfrom
PadzerButch:EOL_53478_EntityDescriptorClientRegistrationProvider

Conversation

@PadzerButch

Copy link
Copy Markdown
Contributor

Closes #55091

@PadzerButch PadzerButch changed the title Removing deprecated AdapterInstallationClientRegistrationProvider Client Registration Provider Removing deprecated EntityDescriptorClientRegistrationProvider Client Registration Provider Nov 12, 2026
@PadzerButch
PadzerButch force-pushed the EOL_53478_EntityDescriptorClientRegistrationProvider branch 2 times, most recently from 5886d6e to ca12cec Compare November 16, 2026 17:15
…ent Registration Provider

Closes keycloak#55091

Signed-off-by: Paddy Buckley <paddy.buckley@ibm.com>

# Conflicts:
#	docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc
#	docs/guides/securing-apps/client-registration.adoc
#	tests/base/src/test/java/org/keycloak/tests/client/SAMLClientRegistrationTest.java
@PadzerButch
PadzerButch force-pushed the EOL_53478_EntityDescriptorClientRegistrationProvider branch from ca12cec to db49a17 Compare November 16, 2026 17:39
@PadzerButch
PadzerButch marked this pull request as ready for review November 16, 2026 20:40
@PadzerButch
PadzerButch requested review from a team as code owners November 16, 2026 20:40
Copilot AI balanced review requested due to automatic review settings November 16, 2026 20:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The SAML endpoint-removal test can pass with the old behavior because an unrelated attribute-merge error satisfies its assertions, so it must assert “Endpoint not supported: saml2” instead.

1 open issue
What changed in this PR

Removes the deprecated SAML Entity Descriptor client registration provider and its Java API and CLI support, addressing #55091. SAML descriptor conversion through the Admin REST API remains available.

Changes:

  • Removes the server provider, registration hooks, and associated client APIs.
  • Replaces obsolete SAML registration tests with endpoint-removal checks and deletes unused fixtures.
  • Updates documentation with removal details and migration guidance.
File Description
tests/​base/​src/​test/​resources/​org/​keycloak/​tests/​client/​clientreg-test/​saml-entity-descriptor.xml Deletes the obsolete registration fixture.
tests/​base/​src/​test/​resources/​org/​keycloak/​tests/​cli/​kcreg/​saml-sp-metadata.xml Deletes the obsolete CLI fixture.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​SAMLClientRegistrationTest.java Removes tests for the deleted provider.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​ClientRegistrationTest.java Adds a 404 check for the removed endpoint.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​KcRegCreateTest.java Replaces SAML creation coverage with a rejection test.
services/​src/​main/​resources/​META-INF/​services/​org.keycloak.services.clientregistration.ClientRegistrationProviderFactory Removes provider discovery registration.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​ClientRegistrationService.java Removes the deleted provider from deprecation tracking.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​ClientRegistrationAuth.java Removes SAML endpoint-specific protocol checking.
services/​src/​main/​java/​org/​keycloak/​protocol/​saml/​clientregistration/​EntityDescriptorClientRegistrationProviderFactory.java Deletes the provider factory.
services/​src/​main/​java/​org/​keycloak/​protocol/​saml/​clientregistration/​EntityDescriptorClientRegistrationProvider.java Deletes the registration provider.
services/​src/​main/​java/​org/​keycloak/​protocol/​saml/​clientregistration/​EntityDescriptorClientRegistrationContext.java Deletes the provider-specific context.
integration/​client-registration/​src/​main/​java/​org/​keycloak/​client/​registration/​ClientRegistration.java Removes the SAML registration API.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​EndpointType.java Removes the SAML endpoint type.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​UpdateCmd.java Removes an obsolete SAML comment only.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​GetCmd.java Removes the SAML switch branch.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​CreateCmd.java Removes SAML response handling and help text.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​CmdStdinContext.java Removes XML-based SAML format detection.
docs/​guides/​securing-apps/​client-registration.adoc Removes documentation for the deleted provider and API.
docs/​documentation/​upgrading/​topics/​changes/​changes-27_0_0.adoc Documents removal and the Admin REST API alternative.

Review effort: Balanced

" --realm test -e saml2 -s clientId=saml2_removed_client -t " + token);

Assertions.assertNotEquals(0, exe.exitCode(), "exitCode != 0");
Assertions.assertFalse(exe.stderrLines().isEmpty(), "error reported on stderr");
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove deprecated EntityDescriptorClientRegistrationProvider Client Registration Provider

2 participants