Skip to content

RORDEV-1444 user info source methods description #252

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

Merged
merged 3 commits into from
Apr 11, 2025

Conversation

Dzuming
Copy link
Collaborator

@Dzuming Dzuming commented Apr 4, 2025

Summary by CodeRabbit

  • Documentation
    • Enhanced the Kibana plugin guide with clearer instructions for configuring OpenID Connect (OIDC) user profile retrieval.
    • Detailed two approaches for obtaining user profile information: one via an external endpoint (default) and another by extracting it directly from the access token.
    • Added a new configuration option userInfoSource with an illustrative example to assist users in setup, while retaining existing client authentication instructions.

Copy link

coderabbitai bot commented Apr 4, 2025

Walkthrough

The pull request updates the kibana.md documentation by introducing a new section under the readonlyrest_kbn.auth.oidc_kc block. It details the new userInfoSource configuration option for retrieving OIDC user profile information. Two methods are described: the default user_info_endpoint, which makes an additional call to the designated URL, and access_token, which extracts the profile directly from the token. An example configuration is provided, and the existing documentation on client authentication methods is retained.

Changes

File Change Summary
kibana.md Added documentation for the new userInfoSource option in the readonlyrest_kbn.auth.oidc_kc block. Explains two methods: user_info_endpoint (default) and access_token, with an illustrative configuration example. Retains details on client authentication methods.

Poem

I'm a rabbit with a joyful hop,
Scurrying through docs where new options crop.
With userInfoSource shining bright,
I nibble on config carrots day and night.
Hopping along with code so neat—
My ears twitch happy for every updated beat!
🥕🐇

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 350fadc and 5b6114d.

📒 Files selected for processing (1)
  • kibana.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • kibana.md

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
kibana.md (1)

1169-1183: Enhance Clarity for userInfoSource Default Behavior
The new "User Info Source Methods" section provides a clear description of the two available methods for obtaining OIDC user profile information. The YAML snippet example illustrates how to set the option correctly. However, note that the description states that user_info_endpoint (default) is used when no value is provided, but the example uses 'access_token'. This might confuse readers as to what the default behavior is. Consider adding a brief note explicitly stating that if the parameter is omitted, the plugin will default to using user_info_endpoint.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b78c6be and fa2d3d1.

📒 Files selected for processing (1)
  • kibana.md (1 hunks)

@Dzuming Dzuming merged commit 7a27871 into develop Apr 11, 2025
3 checks passed
@coutoPL coutoPL deleted the RORDEV-1444-user-info-source-methods-description branch April 24, 2025 18:12
Dzuming added a commit that referenced this pull request Apr 26, 2025
* commit new action strings

* [RORDEV-1317] ror-tools patching confirmation docs (#251)

Docs

* RORDEV-1262 improvements

* RORDEV-1262 improvements

* RORDEV-1262 Add documentation for extending Kibana API with x-ror-tenancy-id header (#253)

* RORDEV-1262 Add documentation for extending Kibana API with x-ror-tenancy-id header

* RORDEV-1262 Add info about id

* RORDEV-1262 add info about default value

* update description

* update based on coderabbit suggestions

* update message

* change endpoint to /tenants

* RORDEV-1444 user info source methods description (#252)

* RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml (#256)

* RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml

* RORDEV-1446 review comment

* commit new action strings

* commit new action strings

* commit new action strings

* commit new action strings

* RORDEV-1262 adjust endpoint

* RORDEV-1262 cr comments resolving

* RORDEV-1262 improvements

* RORDEV-1262 improvements

* update description

* update based on coderabbit suggestions

* update message

* change endpoint to /tenants

* RORDEV-1262 adjust endpoint

* RORDEV-1262 cr comments resolving

* RORDEV-1262 change example

* RORDEV-1262 change all tenants to user's tenants

* RORDEV-1262 change methods

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: mgoworko <37329559+mgoworko@users.noreply.github.com>
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.

1 participant