Docs: Improve the SSO settings API docs #87599
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
mgyongyosi
reviewed
May 28, 2024
| @@ -26,14 +26,23 @@ title: SSO Settings API | |||
| Available in Public Preview in Grafana 10.4 and on Grafana Cloud behind the `ssoSettingsApi` feature toggle. | |||
There was a problem hiding this comment.
Could you please also update this part? By describing that it's GA since 11 and SAML support is public preview behind the ssoSettingsSAML feature toggle. Thanks!
mgyongyosi
reviewed
May 28, 2024
| The settings managed by this API are stored in the database and override | ||
| [settings from other sources]({{< relref "../../setup-grafana/configure-security/configure-authentication" >}}) | ||
| (arguments, environment variables, settings file, etc). | ||
| Therefore, every time settings for a specific provider are removed at runtime, |
There was a problem hiding this comment.
Suggested change
| Therefore, every time settings for a specific provider are removed at runtime, | |
| Therefore, every time settings for a specific provider are removed or reset to the default settings at runtime, |
mgyongyosi
reviewed
May 28, 2024
| When you submit new settings for a provider via API, | ||
| Grafana verifies whether the given settings are allowed and valid. | ||
| If they are, then Grafana stores the settings in the database and reloads | ||
| Grafana services with no need to restart the instance. |
There was a problem hiding this comment.
I think it'd worth to add a note which says (we have the same note on the configuration pages: example):
If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances.
chri2547
approved these changes
May 28, 2024
|
@rjcrutch Could you please review this PR? |
mgyongyosi
approved these changes
May 31, 2024
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.
What is this feature?
Improve the SSO settings API docs.
Why do we need this feature?
Inform users on how to use the SSO settings API.
Who is this feature for?
Anyone using the SSO settings API.
Which issue(s) does this PR fix?:
Fixes #
Special notes for your reviewer:
Please check that: