Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Improve SSO Settings docs #83914

Merged
merged 3 commits into from Mar 9, 2024
Merged

Docs: Improve SSO Settings docs #83914

merged 3 commits into from Mar 9, 2024

Conversation

mgyongyosi
Copy link
Contributor

What is this feature?
Crosslink required steps to enable Users to login using the same email with different OAuth providers.

Why do we need this feature?

[Add a description of the problem the feature is trying to solve.]

Who is this feature for?

[Add information on what kind of user the feature is for.]

Which issue(s) does this PR fix?:

Fixes #

Special notes for your reviewer:

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@mgyongyosi mgyongyosi added type/docs area/auth area/auth/oauth no-changelog Skip including change in changelog/release notes labels Mar 5, 2024
@mgyongyosi mgyongyosi added this to the 11.0.x milestone Mar 5, 2024
@mgyongyosi mgyongyosi requested a review from lwandz13 March 5, 2024 14:46
@@ -21,6 +21,10 @@ weight: 800

The Azure AD authentication allows you to use an Azure Active Directory tenant as an identity provider for Grafana. You can use Azure AD application roles to assign users and groups to Grafana roles from the Azure Portal.

{{% admonition type="note" %}}
If Users use the same email address in Azure AD that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in Azure AD that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in Azure AD that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

@@ -23,6 +23,10 @@ weight: 900

This topic describes how to configure GitHub OAuth2 authentication.

{{% admonition type="note" %}}
If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

@@ -23,6 +23,10 @@ weight: 1000

This topic describes how to configure GitLab OAuth2 authentication.

{{% admonition type="note" %}}
If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

@@ -16,6 +16,10 @@ weight: 1100

To enable Google OAuth2 you must register your application with Google. Google will generate a client ID and secret key for you to use.

{{% admonition type="note" %}}
If Users use the same email address in Google that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in Google that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in Google that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

@@ -24,6 +24,10 @@ Keycloak OAuth2 authentication allows users to log in to Grafana using their Key

Refer to [Generic OAuth authentication]({{< relref "../generic-oauth" >}}) for extra configuration options available for this provider.

{{% admonition type="note" %}}
If Users use the same email address in Keycloak that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in Keycloak that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in Keycloak that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

@@ -16,6 +16,10 @@ weight: 1400

{{< docs/shared lookup="auth/intro.md" source="grafana" version="<GRAFANA VERSION>" >}}

{{% admonition type="note" %}}
If Users use the same email address in Okta that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The relref shortcode argument '{{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md file either by its path or by its containing folder without the ending /.
You can reference an _index.md file only by its containing folder.

Remove the trailing slash to make sure that changing the index type doesn't break the link.

Suggested change
If Users use the same email address in Okta that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication/#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.
If Users use the same email address in Okta that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information.

Copy link
Collaborator

@lwandz13 lwandz13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@chri2547 chri2547 removed their request for review March 6, 2024 17:43
@mgyongyosi mgyongyosi merged commit 0b71354 into main Mar 9, 2024
11 checks passed
@mgyongyosi mgyongyosi deleted the sso/update-api-docs branch March 9, 2024 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/auth/oauth area/auth no-changelog Skip including change in changelog/release notes type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants