[Docs] Add auth_provider_hint to authentication docs #104132
Merged
Conversation
This file contains 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
jportner
added
v8.0.0
release_note:skip
jportner
added
the
auto-backport
azasypkin
approved these changes
Jul 5, 2021
There was a problem hiding this comment.
LGTM, thanks!
I was always hesitating to document this option to keep the right to change it at any time. But it seems we recommend it to our users in various corner cases more and more now that makes it a de facto public API we have to support anyway, so 👍 .
| @@ -65,6 +65,10 @@ image::user/security/images/kibana-login.png["Login Selector UI"] | |||
|
|
|||
| For more information, refer to <<authentication-security-settings, authentication security settings>>. | |||
|
|
|||
| TIP: If you have multiple authentication providers configured, you can use the `auth_provider_hint` URL query parameter to create a deep | |||
| link to any provider and bypass the Login Selector UI. Using the `kibana.yml` above as an example, you can add `?auth_provider_hint=basic1` | |||
There was a problem hiding this comment.
optional nit: we may want to also add that it would work even if this particular option isn't displayed in Login Selector UI.
There was a problem hiding this comment.
Ah, it's good to know that. I think in the interest of brevity I will leave it as-is, but if we get questions about that down the road we can always add it 👍
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 6, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 6, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 6, 2021
This was referenced Jul 6, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 6, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 6, 2021
kibanamachine
added a commit
that referenced
this pull request
Jul 6, 2021
kibanamachine
added a commit
that referenced
this pull request
Jul 6, 2021
kibanamachine
added a commit
that referenced
this pull request
Jul 6, 2021
kibanamachine
added a commit
that referenced
this pull request
Jul 6, 2021
kibanamachine
added a commit
that referenced
this pull request
Jul 6, 2021
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.
Some users want to show the login selector, but also to craft specific URLs for individual authentication providers. This is actually as of 7.11+ with the
auth_provider_hintURL query parameter.This PR adds a tip to the Kibana Authentication docs to mention that parameter.
Docs preview: https://kibana_104132.docs-preview.app.elstc.co/diff