From 1d252de1e9a74cda990b6ee07ffdc27b455f801a Mon Sep 17 00:00:00 2001 From: Misi Date: Wed, 9 Jul 2025 16:22:07 +0200 Subject: [PATCH] Docs: Clean up ssoSettingsApi references from docs (#107896) * Clean up ssoSettingsApi references from docs * lint --- .../configure-authentication/azuread/index.md | 8 -------- .../configure-authentication/generic-oauth/index.md | 8 -------- .../configure-authentication/github/index.md | 8 -------- .../configure-authentication/gitlab/index.md | 4 ---- .../configure-authentication/google/index.md | 8 -------- .../configure-authentication/okta/index.md | 8 -------- .../configure-authentication/saml/_index.md | 2 +- pkg/login/social/socialimpl/service_test.go | 2 +- 8 files changed, 2 insertions(+), 46 deletions(-) diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md index 5091d40fd94..2405baa4ca0 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md @@ -239,10 +239,6 @@ Ensure that you have followed the steps in [Create the Microsoft Entra ID applic ## Configure Azure AD authentication client using the Grafana UI -{{< admonition type="note" >}} -Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. -{{< /admonition >}} - As a Grafana Admin, you can configure your Azure AD/Entra ID OAuth client from within Grafana using the Grafana UI. To do this, navigate to the **Administration > Authentication > Azure AD** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations. @@ -255,10 +251,6 @@ If you run Grafana in high availability mode, configuration changes may not get ## Configure Azure AD authentication client using the Terraform provider -{{< admonition type="note" >}} -Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "azuread_sso_settings" { provider_name = "azuread" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md index 3beaeca97ff..d1a613d6b66 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md @@ -49,10 +49,6 @@ If Users use the same email address in Azure AD that they use with other authent ## Configure generic OAuth authentication client using the Grafana UI -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. -{{< /admonition >}} - As a Grafana Admin, you can configure Generic OAuth client from within Grafana using the Generic OAuth UI. To do this, navigate to **Administration > Authentication > Generic OAuth** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations. @@ -67,10 +63,6 @@ Refer to [configuration options](#configuration-options) for more information. ## Configure generic OAuth authentication client using the Terraform provider -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "generic_sso_settings" { provider_name = "generic_oauth" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md index 25e83cfd5e6..86edef93132 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md @@ -43,10 +43,6 @@ Ensure you know how to create a GitHub OAuth app. Consult GitHub's documentation ## Configure GitHub authentication client using the Grafana UI -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. -{{< /admonition >}} - As a Grafana Admin, you can configure GitHub OAuth client from within Grafana using the GitHub UI. To do this, navigate to **Administration > Authentication > GitHub** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. After you have filled in the form, click **Save**. If the save was successful, Grafana will apply the new configurations. @@ -61,10 +57,6 @@ Refer to [configuration options](#configuration-options) for more information. ## Configure GitHub authentication client using the Terraform provider -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "github_sso_settings" { provider_name = "github" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md index ad42174ae64..8f0aaf0f38f 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md @@ -57,10 +57,6 @@ Refer to [configuration options](#configuration-options) for more information. ## Configure GitLab authentication client using the Terraform provider -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "gitlab_sso_settings" { provider_name = "gitlab" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md index 4561f6c63b3..b162eb52305 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md @@ -45,10 +45,6 @@ First, you need to create a Google OAuth Client: ## Configure Google authentication client using the Grafana UI -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. -{{< /admonition >}} - As a Grafana Admin, you can configure Google OAuth client from within Grafana using the Google UI. To do this, navigate to **Administration > Authentication > Google** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. After you have filled in the form, click **Save**. If the save was successful, Grafana will apply the new configurations. @@ -61,10 +57,6 @@ If you run Grafana in high availability mode, configuration changes may not get ## Configure Google authentication client using the Terraform provider -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "google_sso_settings" { provider_name = "google" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md index 1323a6ed423..93a21c70bc1 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md @@ -101,10 +101,6 @@ If you want to configure the role for all users in the Okta directory, you can a ## Configure Okta authentication client using the Grafana UI -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. -{{< /admonition >}} - As a Grafana Admin, you can configure Okta OAuth2 client from within Grafana using the Okta UI. To do this, navigate to **Administration > Authentication > Okta** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. After you have filled in the form, click **Save**. If the save was successful, Grafana will apply the new configurations. @@ -119,10 +115,6 @@ Refer to [configuration options](#configuration-options) for more information. ## Configure Okta authentication client using the Terraform provider -{{< admonition type="note" >}} -Available behind the `ssoSettingsAPI` feature toggle, which is enabled by default. Supported in the Terraform provider since v2.12.0. -{{< /admonition >}} - ```terraform resource "grafana_sso_settings" "okta_sso_settings" { provider_name = "okta" diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/_index.md index 06a38944b83..4a846a622e2 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/_index.md @@ -40,7 +40,7 @@ If you are using Okta or Azure AD as Identity Provider, see the following docume - [Configure SAML with Okta](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/) {{< admonition type="note" >}} -The API and Terraform support are available in Public Preview in Grafana v11.1 behind the `ssoSettingsSAML` feature toggle. You must also enable the `ssoSettingsApi` flag. +The API and Terraform support are available in Public Preview in Grafana v11.1 behind the `ssoSettingsSAML` feature toggle. {{< /admonition >}} All methods offer the same configuration options. However, if you want to keep all of Grafana authentication settings in one place, use the Grafana configuration file or the Terraform provider. If you are a Grafana Cloud user, you do not have access to Grafana configuration file. Instead, configure SAML through the other methods. diff --git a/pkg/login/social/socialimpl/service_test.go b/pkg/login/social/socialimpl/service_test.go index 870c13cf8e3..74760f0a3b5 100644 --- a/pkg/login/social/socialimpl/service_test.go +++ b/pkg/login/social/socialimpl/service_test.go @@ -36,7 +36,7 @@ func TestIntegrationSocialService_ProvideService(t *testing.T) { expectedGenericOAuthSkipOrgRoleSync bool }{ { - name: "should load all social connectors when ssoSettingsApi is enabled", + name: "should load all social connectors", expectedSocialMapLength: 7, expectedGenericOAuthSkipOrgRoleSync: false, },