RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml #256
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rs-via-kibana.yml
WalkthroughThe documentation in Changes
Suggested reviewers
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
kibana.md:1231
- [nitpick] Consider aligning the YAML key structure with the SAML configuration block (which uses a top-level 'readonlyrest_kbn:' key followed by an indented 'auth:' block) to enhance consistency.
readonlyrest_kbn.auth:
kibana.md:1248
- [nitpick] Consider aligning the YAML key structure with the SAML configuration block (which uses a top-level 'readonlyrest_kbn:' key followed by an indented 'auth:' block) to enhance consistency.
readonlyrest_kbn.auth:
kibana.md
Outdated
| When configuring SAML authentication in ReadonlyREST Enterprise, you can provide additional parameters to customize the behavior of the SAML service provider integration. | ||
| These parameters allow for fine-tuning the SAML integration to work with various identity providers and specific configurations | ||
|
|
||
| You can find a list of all supported parameters in a [documentation](https://github.com/node-saml/passport-saml/tree/3.x?tab=readme-ov-file#config-parameter-details) |
There was a problem hiding this comment.
[nitpick] Consider updating the link text to be more descriptive (e.g., 'Passport-SAML Configuration Parameters') rather than a generic 'documentation' label.
Suggested change
| You can find a list of all supported parameters in a [documentation](https://github.com/node-saml/passport-saml/tree/3.x?tab=readme-ov-file#config-parameter-details) | |
| You can find a list of all supported parameters in the [Passport-SAML Configuration Parameters documentation](https://github.com/node-saml/passport-saml/tree/3.x?tab=readme-ov-file#config-parameter-details) |
Copilot uses AI. Check for mistakes.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
kibana.md (2)
1064-1071: SAML Additional Parameters Documentation UpdateThe new "Additional Parameters" section for SAML is clear and informative. It appropriately explains that extra parameters can be passed to fine-tune the SAML service provider integration. Two specific suggestions:
- Provide a YAML snippet example: For consistency with the OIDC section later on, consider adding a sample YAML code block that shows how users can pass these parameters via
kibana.yml. This will help readers quickly see an example usage.- Fix a stray backtick: In the sample snippet (if present), the audience URL appears with a trailing backtick. For example, change:
- audience: "https://sp.example.com/metadata"` + audience: "https://sp.example.com/metadata"
1219-1267: OIDC Additional Parameters Documentation UpdateThe added section on configuring additional parameters for OpenID Connect (OIDC) is comprehensive and well-structured. It provides both high-level guidance and concrete YAML examples (for issuer and client additional parameters) along with links to external documentation for further details. A couple of minor points for enhancement:
- Verify that the indentation and formatting in the YAML examples are consistent with the rest of the documentation.
- Double-check that all example values (e.g., URLs and placeholders) are clearly marked as examples so users know they need to be customized.
coutoPL
deleted the
RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml
branch
coutoPL
pushed a commit
that referenced
this pull request
Apr 24, 2025
…rs-via-kibana.yml (#256) * RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml * RORDEV-1446 review comment
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit