Skip to content

Fix the Keycloak Admin Client NuGet link - #1999

Merged
David Pine (IEvangelist) merged 1 commit into
mainfrom
aspireagent/fix-keycloak-admin-sdk-link
Oct 30, 2026
Merged

David Pine (IEvangelist) merged 1 commit into
mainfrom
aspireagent/fix-keycloak-admin-sdk-link

Conversation

@davidfowl

Copy link
Copy Markdown
Contributor

Summary

The Keycloak integration page suggests initializing realms with the "Keycloak Admin Client". That package doesn't exist on NuGet, so readers land on a "package not found" page.

The Admin REST API client from the same project ships in Keycloak.AuthServices.Sdk. This PR points the link there; the link text is unchanged.

Evidence

  • NuGet v3 flat container:
    • api.nuget.org/v3-flatcontainer/keycloak.authservices.sdk.admin/index.json returns 404.
    • .../keycloak.authservices.sdk/index.json returns 200 (latest 3.0.0).
  • NuGet search for Keycloak.AuthServices lists Authentication, Authorization, Common, Sdk, Sdk.Kiota, OpenTelemetry, Aspire.Hosting, Authorization.TokenIntrospection, Templates and Authorization.Uma. There's no Sdk.Admin.
  • The Keycloak.AuthServices.Sdk 3.0.0 NuGet description reads: "HttpClient integration with Keycloak. Includes HTTP Admin REST API, Protection API."
  • The upstream Keycloak.AuthServices README "Invoke Admin API" example uses this package's AddKeycloakAdminHttpClient and IKeycloakRealmClient to create and read realms. That matches the docs context: creating and configuring realms, clients and users. Keycloak.AuthServices.Sdk.Kiota also exists, but it's the Kiota-generated alternative; the primary admin client is Sdk.
  • Overlap: no open aspire.dev issue or PR mentions Keycloak.AuthServices. Open PRs chore: Update integration data and GitHub stats (11/4/26) #1737 and Generate the canonical polyglot AppHost API reference #1637 touch only generated Keycloak API data, not keycloak.mdx.

This change isn't visual. Only the link target changes.

Third-party links and affiliations

Changes one third-party link from https://www.nuget.org/packages/Keycloak.AuthServices.Sdk.Admin (nonexistent) to https://www.nuget.org/packages/Keycloak.AuthServices.Sdk, published by the community Keycloak.AuthServices project. No affiliation.

Validation

  • Before/after NuGet API evidence: 404 → 200, as listed above. I didn't add a unit regression check, because the repo's unit tests run offline and have no NuGet existence check to extend.
  • npx vitest run: 1,119 passed, 1 skipped.
  • npx eslint . --max-warnings 0: clean.
  • keycloak.mdx already has Prettier warnings on main; this one-line change doesn't affect them.

🤖 Posted by AspireAgent (AI Agent)

The Keycloak hosting page linked to Keycloak.AuthServices.Sdk.Admin,
which does not exist on NuGet. The Keycloak Admin REST API client ships
in Keycloak.AuthServices.Sdk (AddKeycloakAdminHttpClient,
IKeycloakRealmClient).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1999. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1999 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

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

The Keycloak NuGet link correction has no active review issues.

No open issues 🎉

What changed in this PR

Corrects the NuGet link in the Keycloak integration guide so readers can find the package containing the Admin REST API client.

Changes:

  • Replaces Keycloak.AuthServices.Sdk.Admin with Keycloak.AuthServices.Sdk in the link target.
  • Keeps the link text and surrounding initialization guidance unchanged.
File Description
src/​frontend/​src/​content/​docs/​integrations/​security/​keycloak.mdx Corrects the Keycloak Admin Client NuGet URL.

Review effort: Balanced

@IEvangelist
David Pine (IEvangelist) enabled auto-merge (squash) October 30, 2026 16:32
@IEvangelist
David Pine (IEvangelist) merged commit f05f556 into main Oct 30, 2026
20 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the aspireagent/fix-keycloak-admin-sdk-link branch October 30, 2026 16:32
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.

3 participants