Skip to content
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.

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

[24.2] Show Keycloak provider label in UI #19447

Conversation

ahmedhamidawan
Copy link
Member

Fixes #19410

If there is a <label> provided in oidc_backends_config, we show that in the UI instead of just the provider name.

For instance, when we provide the label here:

<provider name="Keycloak">
      <!-- The URL should include the base keycloak path as well as the realm -->
      <url>https://keycloak.example.org/realms/master/</url>
      <client_id> ... </client_id>
      <client_secret> ... </client_secret>
      <redirect_uri>http://localhost:8080/authnz/keycloak/callback</redirect_uri>
      <!-- (Optional): a provider label to display in the UI -->
      <label>Fancy ORG with Keycload Auth</label>

We see it in the sign in or disconnect provider buttons:

use_keycloak_label_in_ui.mp4

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

Copy link
Contributor

@davelopez davelopez left a comment

Choose a reason for hiding this comment

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

Thank you @ahmedhamidawan!

@davelopez
Copy link
Contributor

Hmm, since I realize this is a fix, maybe you can target 24.2?

ahmedhamidawan and others added 3 commits January 27, 2025 11:11
Fixes galaxyproject#19410

If there is a `<label>` provided in `oidc_backends_config`, we show that in the UI instead of just the provider name.
@ahmedhamidawan ahmedhamidawan force-pushed the use_keycloak_label_in_ui branch from 4d0655b to 99f3f20 Compare January 27, 2025 17:12
@ahmedhamidawan ahmedhamidawan changed the base branch from dev to release_24.2 January 27, 2025 17:12
@ahmedhamidawan ahmedhamidawan changed the title Show Keycloak provider label in UI [24.2] Show Keycloak provider label in UI Jan 27, 2025
@ahmedhamidawan ahmedhamidawan merged commit 1f9b2f7 into galaxyproject:release_24.2 Jan 28, 2025
57 of 60 checks passed
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.

clarify/prevent usage of "Keycloak" in the UI
2 participants