From 8fb2b5022bba0a9774d5dcc5642c9393fd3c1f36 Mon Sep 17 00:00:00 2001 From: linoman <2051016+linoman@users.noreply.github.com> Date: Wed, 17 Sep 2025 13:47:22 +0200 Subject: [PATCH] SAML Catalog: Add documentation for OIN (#111193) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Improve docs for consistency * Add docs for Okta catalog application * Add supported features * Fix Markdown formatting in SAML with Okta guide --------- Co-authored-by: Irene Rodríguez --- .../configure-authentication/saml/_index.md | 3 +- .../oin-application.md | 62 +++++++++++++++++++ 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 docs/sources/setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/oin-application.md 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 40cfc2441d8..c5785c107a6 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 @@ -29,7 +29,7 @@ SAML authentication integration allows your Grafana users to log in by using an You can configure SAML authentication in Grafana through one of the following methods: -- [Configure SAML using Grafana configuration file](#configure-saml-using-the-grafana-config-file) +- Configure SAML using the [Grafana configuration file](#configure-saml-using-the-grafana-config-file) - Configure SAML using the [SSO Settings API](https://grafana.com/docs/grafana//developers/http_api/sso-settings/) - Configure SAML using the [SAML user interface](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-authentication/saml/saml-ui/) - Configure SAML using the [Grafana Terraform provider](https://registry.terraform.io/providers/grafana/grafana//docs/resources/sso_settings) @@ -38,6 +38,7 @@ If you are using Okta or Azure AD as Identity Provider, see the following docume - [Configure SAML with Azure AD](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-azuread/) - [Configure SAML with Okta](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/) +- [Configure SAML with Okta catalog application](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/oin-application) 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/docs/sources/setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/oin-application.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/oin-application.md new file mode 100644 index 00000000000..c9346df8921 --- /dev/null +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/configure-saml-with-okta/oin-application.md @@ -0,0 +1,62 @@ +--- +description: Learn how to configure SAML authentication with Okta using the Okta Integration Network (OIN) application. +labels: + products: + - cloud + - enterprise +menuTitle: Configure SAML with Okta catalog application +title: Configure SAML with Okta catalog application +weight: 590 +--- + +# Configure SAML with Okta catalog application + +Grafana offers multiple ways to configure the SAML authentication flow. This guide focuses on configuring the authentication flow using the Okta Integration Network (OIN) application. + +The Grafana Labs application can be found in the [Okta Integration Network catalog](https://www.okta.com/integrations/). + +## Prerequisites + +- Grafana Enterprise or a paid Grafana Cloud account. +- Admin privileges in both Grafana and Okta. + +## Supported features + +- SAML Single Sign-On (SSO) +- SAML Attribute Mapping +- SAML Group Mapping +- SAML External ID Mapping for SCIM provisioning + +## Configure SAML using the OIN application + +### At the Okta Integration Network catalog + +1. Visit the [Okta Integration Network catalog](https://www.okta.com/integrations/) and search for **Grafana Labs**. +1. Within the **Grafana Labs** application page, click on **+Add Integration**. +1. Select the tenant to add the integration to. + +### At the Grafana Labs application page + +1. If needed, update the **Application label**. +1. Set the domain name. For example, `your-grafana-domain.grafana.net`. +1. Click on **Done**. + +| Field | Description | +| --------------------- | ---------------------------------------- | +| **Application label** | The name of the application. | +| **Domain name** | The domain name of the Grafana instance. | + +### At the Grafana Labs Integration page + +1. At the **Assignments** tab, add the groups or users that should have access to the application. +1. At the **Sign On** tab, copy the _Metadata URL_. + +## Update SAML configuration at Grafana + +### At the Grafana Labs SAML settings page + +1. Navigate to the **SAML settings** page within the **Authentication** section from the left-hand menu. +1. The only required step is pasting the _Metadata URL_ in the **IdP Metadata URL** field, located at the **3. Connect Grafana with Identity Provider** tab. +1. Save and apply the changes. + +With this configuration, the users will be able to access Grafana using their Okta credentials.