This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.
Configure SCIM with Okta
Note
Available in Grafana Enterprise and Grafana Cloud Pro and Advanced.
This guide explains how to configure SCIM provisioning with Okta to automate user and team management in Grafana.
Note
This feature is behind the
enableSCIM
feature toggle. You can enable feature toggles through configuration file or environment variables.For more information, refer to the feature toggles documentation.
Prerequisites
Before configuring SCIM with Okta, ensure you have:
- Grafana Enterprise or Grafana Cloud Advanced
- Admin access to both Grafana and Okta
- SAML authentication configured with Okta
- SCIM feature enabled in Grafana
Note
Important SAML and SCIM Configuration: When using SAML for authentication alongside SCIM provisioning with Okta, it is crucial to correctly align user identifiers. For detailed information on why this is critical for security and how to configure it, refer to the main SCIM provisioning documentation.
Ensure your Okta SAML application is configured to send a stable, unique identifier (that will map to the Grafana SCIM
externalId
) as a SAML claim. Then, configure the Grafana SAML settings to use this claim. For general Okta SAML setup, refer to Set up SAML with Okta.
Configure SCIM in Grafana
To enable SCIM provisioning in Grafana, create a service account and generate an access token that will be used to authenticate SCIM requests from Okta.
Create a service account
- Navigate to Administration > Users and access > Service accounts
- Click Add service account
- Create a new service account with Admin role
- Create a new token for the newly created service account and save it securely
- This token will be used in the Okta configuration
Configure SCIM in Okta
Configure both SAML authentication and SCIM provisioning in Okta to enable automated user and team synchronization with Grafana. Start by creating a SAML application, then enable and configure SCIM provisioning for that application.
Enable SCIM provisioning
- Navigate to the General tab of your SAML App Integration in Okta
- Enable SCIM provisioning
- A new provisioning tab will appear
Configure provisioning settings
To enable user provisioning through SCIM, configure the SCIM integration settings in Grafana by specifying the connector URL, authentication mode, and supported provisioning actions. Follow these steps to complete the integration.
Configure SCIM integration
In the Integration tab, configure:
- SCIM Connector base URL:
- For Grafana Cloud instances:Replace
https://{stack-name}.grafana.net/apis/scim.grafana.app/v0alpha1/namespaces/stacks-{stack-id}
{stack-name}
and{stack-id}
with your Grafana Cloud stack name and ID. - For self-hosted instances:Replace
https://{your-grafana-domain}/apis/scim.grafana.app/v0alpha1/namespaces/default
{your-grafana-domain}
with your Grafana instance’s domain (e.g.,grafana.yourcompany.com
).
- For Grafana Cloud instances:
- Unique identifier field: userName
- Supported provisioning actions:
- Import New Users and Profile Updates
- Push New Users
- Push Profile Updates
- Authentication Mode: HTTP Header
- Authorization: Bearer {your-grafana-service-account-token}
- Click Test Connector Configuration and then save the configuration
In the To App tab, enable:
- Create Users
- Update User Attributes
- Deactivate Users
After completing the configuration:
- Test the SCIM connector in Okta
- Assign a test user to the application
- Verify the user is provisioned in Grafana