[7.11] Fix embedding docs #94371
Merged
[7.11] Fix embedding docs #94371
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
The docs that were backported to 7.11 described the Public URL feature, which is not available until 7.12. This commit simply reverts this section back to what it was before.
jportner
added
the
release_note:skip
jportner
commented
Mar 10, 2021
Comment on lines
386
to
402
| If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding dashboards and visualizations, then toggle *Public URL* in the *Share > Embed code* menu in *Dashboard* or *Visualize*. | ||
| If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding, then you will need to add the `auth_provider_hint=<anonymous-provider-name>` query string parameter to the {kib} URL that you're embedding. | ||
|
|
||
| You can also use the *Public URL* toggle when you're generating permanent links to dashboards, visualizations, and saved searches. | ||
| For example, if you generate the iframe code to embed {kib}, it will look like this: | ||
|
|
||
| NOTE: The *Public URL* toggle is only available if anonymous access is properly configured and your anonymous service account has privileges to access what you want to embed or share. | ||
| ```html | ||
| <iframe src="https://localhost:5601/app/dashboards#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?embed=true&_g=(....)" height="600" width="800"></iframe> | ||
| ``` | ||
|
|
||
| To make this iframe leverage anonymous access automatically, you will need to modify a link to {kib} in the `src` iframe attribute to look like this: | ||
|
|
||
| ```html | ||
| <iframe src="https://localhost:5601/app/dashboards?auth_provider_hint=anonymous1#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?embed=true&_g=(....)" height="600" width="800"></iframe> | ||
| ``` | ||
|
|
||
| Note that `auth_provider_hint` query string parameter goes *before* the hash URL fragment. | ||
|
|
||
| For more information, refer to <<embedding, Embed {kib} content in a web page>>. |
There was a problem hiding this comment.
This basically duplicates the content that the aforementioned PR moved to the linked embedding page.
Alternatively, we could change this to just say:
If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding, then you will need to manually modify the {kib} URL in the iframe code. For more information, refer to <<embedding, Embed {kib} content in a web page>>.
There was a problem hiding this comment.
I prefer the shorter version.
gchaps
approved these changes
Mar 10, 2021
Comment on lines
386
to
402
| If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding dashboards and visualizations, then toggle *Public URL* in the *Share > Embed code* menu in *Dashboard* or *Visualize*. | ||
| If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding, then you will need to add the `auth_provider_hint=<anonymous-provider-name>` query string parameter to the {kib} URL that you're embedding. | ||
|
|
||
| You can also use the *Public URL* toggle when you're generating permanent links to dashboards, visualizations, and saved searches. | ||
| For example, if you generate the iframe code to embed {kib}, it will look like this: | ||
|
|
||
| NOTE: The *Public URL* toggle is only available if anonymous access is properly configured and your anonymous service account has privileges to access what you want to embed or share. | ||
| ```html | ||
| <iframe src="https://localhost:5601/app/dashboards#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?embed=true&_g=(....)" height="600" width="800"></iframe> | ||
| ``` | ||
|
|
||
| To make this iframe leverage anonymous access automatically, you will need to modify a link to {kib} in the `src` iframe attribute to look like this: | ||
|
|
||
| ```html | ||
| <iframe src="https://localhost:5601/app/dashboards?auth_provider_hint=anonymous1#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?embed=true&_g=(....)" height="600" width="800"></iframe> | ||
| ``` | ||
|
|
||
| Note that `auth_provider_hint` query string parameter goes *before* the hash URL fragment. | ||
|
|
||
| For more information, refer to <<embedding, Embed {kib} content in a web page>>. |
There was a problem hiding this comment.
I prefer the shorter version.
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.
See #90409 (comment):
Docs preview: https://kibana_94371.docs-preview.app.elstc.co/guide/en/kibana/7.11/kibana-authentication.html