Skip to content

Conversation

@bkenez
Copy link
Member

@bkenez bkenez commented Dec 1, 2025

Description

Epic: #4613
Closes: #7108

Adds a coument explaining how to set up the helm chart using the internal Keycloak to broker an external IdP.
Essentially a bridge document between the internal keycloak guide and the external IdP integration, with some additional steps on how to configure groups/roles.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@bkenez bkenez force-pushed the idp-via-internal-keycloak branch from 3a2de2f to 7c25d0a Compare December 1, 2025 10:02
@bkenez bkenez marked this pull request as ready for review December 1, 2025 10:09
@bkenez bkenez changed the title feat: add IdP via internal keycloak doc for helm chart feat(helm-chart): add IdP via internal keycloak doc for helm chart Dec 1, 2025
@bkenez bkenez changed the title feat(helm-chart): add IdP via internal keycloak doc for helm chart feat(helm-chart): add IdP via internal keycloak guide Dec 1, 2025
@mesellings mesellings added the low prio There is no urgency with this change. label Dec 1, 2025
Copy link
Member

@ThorbenLindhauer ThorbenLindhauer left a comment

Choose a reason for hiding this comment

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

Thanks for creating the guide, it's very clear and I was able to make things work in a local setup. I have a few suggestions below, as usual they are up for debate :)


### Add your external IdP to Keycloak

Configure Keycloak to use your external identity provider by following the [Configure an external IdP using Keycloak](/self-managed/components/management-identity/configuration/configure-external-identity-provider.md) guide.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can give it as a follow-up to the docs team to move the linked guide into a central/reference location (as it's not specific to Management Identity anymore).

Copy link
Member Author

@bkenez bkenez Dec 5, 2025

Choose a reason for hiding this comment

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

Yeah this ended up being more generalised 🤔
@giorgionaps consideration for docs team followup

@bkenez bkenez force-pushed the idp-via-internal-keycloak branch from e30cbff to 5473a9e Compare December 5, 2025 14:37
Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - moved the guide to be second-to-last in the section (just above troubleshooting).

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - added clarification that mappers should be configured in the Camunda realm (default: camunda-platform).

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - added username as the suggested name for the username mapper.

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - added brief explanations for each mapper type (attribute mappers, username mapper, and hardcoded group mapper) to help readers understand what each configuration does.

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - added a tip explaining the direct group authorization alternative using the groups-claim feature, which is enabled by default with the internal Keycloak Helm chart setup.

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - added a note clarifying that hardcoded group mappers grant access to all external IdP users, with a link to Keycloak docs for more granular access control options.

Copy link
Member Author

@bkenez bkenez left a comment

Choose a reason for hiding this comment

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

Done - removed the generic 'Understanding the two identity systems' section and moved the link to the 'Next steps' section instead.

Copy link
Member

@ThorbenLindhauer ThorbenLindhauer left a comment

Choose a reason for hiding this comment

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

Thanks for making the adjustments. Looks overall fine, except one comment about the group/mapping rule topic. Please see below.

@bkenez bkenez force-pushed the idp-via-internal-keycloak branch from e6e41c3 to 01616bd Compare December 8, 2025 07:55
@mesellings mesellings requested review from giorgionaps and removed request for a team December 8, 2025 11:43
@mesellings
Copy link
Collaborator

@giorgionaps Please review this once @bkenez confirms it is ready for a TW review (I think there is one outstanding technical review comment) 🙏

Copy link
Member

@ThorbenLindhauer ThorbenLindhauer left a comment

Choose a reason for hiding this comment

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

Thanks, looks good now!

@bkenez
Copy link
Member Author

bkenez commented Dec 8, 2025

@giorgionaps ready for TW review!
Please and thank you 🙏

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

Labels

low prio There is no urgency with this change.

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

Create a guide for how to set up the Helm Chart with an external IdP through Keycloak

4 participants