Skip to content

Removing DefaultClientRegistrationProvider - #55170

Open
PadzerButch wants to merge 3 commits into
keycloak:mainfrom
PadzerButch:EOL_53478_DefaultClientRegistrationProvider
Open

PadzerButch wants to merge 3 commits into
keycloak:mainfrom
PadzerButch:EOL_53478_DefaultClientRegistrationProvider

Conversation

@PadzerButch

@PadzerButch PadzerButch commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Closes #55155

Codex assisted with the upgrade guide correction.

…ent Registration Provider

Closes keycloak#55035

Signed-off-by: Paddy Buckley <paddy.buckley@ibm.com>
@PadzerButch
PadzerButch force-pushed the EOL_53478_DefaultClientRegistrationProvider branch 2 times, most recently from f7c7087 to 699363c Compare November 16, 2026 17:33
@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.

🟢 Approval recommended

No active review issues are recorded for the removal of the deprecated client-registration provider.

No open issues 🎉

What changed in this PR

Removes the deprecated DefaultClientRegistrationProvider and its references, addressing #55155. Client registration now uses OpenID Connect metadata or Admin REST where internal client representations are needed.

Changes:

  • Removes the default provider, its registration, and the corresponding Java client methods.
  • Switches CLI defaults and applicable tests to OIDC while moving internal-representation fixtures to Admin REST.
  • Updates migration guidance, command examples, and server-info mocks.
File Description
testsuite/​integration-arquillian/​tests/​base/​src/​test/​java/​org/​keycloak/​testsuite/​client/​ClientRegistrationTester.java Migrates the registration example to OIDC.
testsuite/​integration-arquillian/​tests/​base/​src/​test/​java/​org/​keycloak/​testsuite/​client/​AbstractClientRegistrationTest.java Creates fixtures and registration tokens through Admin REST.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​keys/​KeyRotationTest.java Migrates registration-token rotation checks to OIDC.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​RegistrationAccessTokenTest.java Uses OIDC for registration-token lifecycle tests.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​policies/​SecureClientNodeExecutorTest.java Removes default-provider registered-node tests.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​InitialAccessTokenTest.java Uses OIDC for initial-access-token tests.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​DcrVaultSecretDisclosureTest.java Removes default-provider secret-update tests.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​DcrSsfPrivilegeEscalationTest.java Migrates service-account protection coverage and removes provider-specific cases.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​ClientRegistrationTest.java Migrates lifecycle tests and checks removed endpoints return 404.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​ClientRegistrationPoliciesTest.java Adapts policy tests to OIDC metadata.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​ClientRegistrationPermissionsTest.java Uses Admin REST fixtures and OIDC permission checks.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​client/​AbstractClientRegistrationTest.java Replaces default registration setup with Admin REST.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​KcRegUpdateTokenTest.java Changes token-command output deserialization to OIDC.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​KcRegUpdateTest.java Tests OIDC fields, generated identifiers, and update merging.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​KcRegTest.java Updates CLI expectations for OIDC defaults.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​KcRegCreateTest.java Migrates creation tests and checks rejection of -e default.
tests/​base/​src/​test/​java/​org/​keycloak/​tests/​cli/​registration/​AbstractRegCliTest.java Migrates shared CLI lifecycle checks to OIDC.
services/​src/​test/​java/​org/​keycloak/​validation/​ClientUriPolicyTest.java Replaces removed registration contexts with OIDC contexts.
services/​src/​test/​java/​org/​keycloak/​validation/​ClientUriFieldTest.java Uses OIDC contexts for URI validation tests.
services/​src/​main/​resources/​META-INF/​services/​org.keycloak.services.clientregistration.ClientRegistrationProviderFactory Removes default-provider service registration.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​policy/​DefaultClientRegistrationPolicies.java Adds comments explaining retention of the default-roles policy.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​DefaultClientRegistrationProviderFactory.java Deletes the default-provider factory.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​DefaultClientRegistrationProvider.java Deletes the deprecated endpoint implementation.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​DefaultClientRegistrationContext.java Deletes the provider-specific context.
services/​src/​main/​java/​org/​keycloak/​services/​clientregistration/​ClientRegistrationService.java Removes default from deprecated-provider tracking.
js/​apps/​admin-ui/​src/​context/​server-info/​__tests__/​mock.json Removes the default provider from server-info fixtures.
js/​apps/​admin-ui/​src/​clients/​add/​__tests__/​mock-serverinfo.json Aligns client-creation fixtures with available providers.
integration/​client-registration/​src/​main/​java/​org/​keycloak/​client/​registration/​ClientRegistration.java Removes Java methods targeting the default endpoint.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​EndpointType.java Removes the default endpoint type.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​UpdateCmd.java Uses OIDC updates and snake-case token metadata.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​GetCmd.java Defaults retrieval to OIDC.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​DeleteCmd.java Routes deletion through the OIDC endpoint.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​CreateCmd.java Defaults creation to OIDC while retaining SAML support.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​commands/​AttrsCmd.java Lists OIDC attributes by default.
integration/​client-cli/​admin-cli/​src/​main/​java/​org/​keycloak/​client/​registration/​cli/​CmdStdinContext.java Removes internal-representation input handling.
docs/​guides/​securing-apps/​client-registration.adoc Documents replacement APIs and updates registration examples.
docs/​guides/​securing-apps/​client-registration-cli.adoc Explains OIDC fields and generated client identifiers.
docs/​documentation/​upgrading/​topics/​changes/​changes-27_0_0.adoc Documents removal, compatibility changes, and migration options.

Review effort: Balanced

… Registration Provider

Closes keycloak#55091

Signed-off-by: Paddy Buckley <paddy.buckley@ibm.com>
@PadzerButch
PadzerButch force-pushed the EOL_53478_DefaultClientRegistrationProvider branch from 699363c to 6491e23 Compare November 17, 2026 16:44
Copilot AI balanced review requested due to automatic review settings November 17, 2026 16:44

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.

🟢 Approval recommended

No active review issues block the removal of deprecated registration providers and migration to OIDC registration and Admin APIs.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 19, 2026 16:14

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.

🟢 Approval recommended

No unresolved review issues are recorded for the removal of deprecated client registration providers.

No open issues 🎉

Review effort: Balanced

@PadzerButch
PadzerButch force-pushed the EOL_53478_DefaultClientRegistrationProvider branch from 3a91bbe to 2da869c Compare November 19, 2026 16:25
Copilot AI balanced review requested due to automatic review settings November 19, 2026 16:25
…tion Provider

Closes keycloak#55155

Signed-off-by: Paddy Buckley <paddy.buckley@ibm.com>
@PadzerButch
PadzerButch force-pushed the EOL_53478_DefaultClientRegistrationProvider branch from 2da869c to c82e7d2 Compare November 19, 2026 16:29

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.

🟢 Approval recommended

No active review issues block approval of the deprecated client-registration provider removal.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 19, 2026 16:30

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.

🟢 Approval recommended

No active review issues are reported for the removal of deprecated client registration providers.

No open issues 🎉

Review effort: Balanced

@keycloak-github-bot keycloak-github-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unreported flaky test detected, please review

@keycloak-github-bot

Copy link
Copy Markdown

Unreported flaky test detected

If the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.adapter.servlet.SAMLClockSkewAdapterTest#testTokenTimeIsValid

Keycloak CI - Adapter IT

org.jboss.arquillian.graphene.enricher.exception.PageObjectInitializationException: 
Can not instantiate Page Object 
class org.keycloak.testsuite.adapter.page.SalesPostClockSkewServlet
 declared in: 
org.keycloak.testsuite.adapter.servlet.SAMLClockSkewAdapterTest
...

Report flaky test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove deprecated DefaultClientRegistrationProvider Client Registration Provider

2 participants