mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 20:22:30 +08:00
2a6736aae3
* Docs: Clarify how authNZ works when SCIM is enabled * Use Grafana Cloud instead of grafana.com
127 lines
8.0 KiB
Markdown
127 lines
8.0 KiB
Markdown
---
|
|
description: Learn how to use SCIM provisioning to synchronize users and groups from your identity provider to Grafana. SCIM enables automated user management, team provisioning, and enhanced security through real-time synchronization with your identity provider.
|
|
keywords:
|
|
- grafana
|
|
- scim
|
|
- provisioning
|
|
- user-management
|
|
- team-management
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
menuTitle: Configure SCIM provisioning
|
|
title: Configure SCIM provisioning
|
|
weight: 300
|
|
---
|
|
|
|
# Configure SCIM provisioning
|
|
|
|
System for Cross-domain Identity Management (SCIM) is an open standard that allows automated user provisioning and management. With SCIM, you can automate the provisioning of users and groups from your identity provider to Grafana.
|
|
|
|
{{< admonition type="note" >}}
|
|
Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud Advanced](/docs/grafana-cloud/).
|
|
{{< /admonition >}}
|
|
|
|
{{< admonition type="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](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#feature_toggles).
|
|
{{< /admonition >}}
|
|
|
|
## Benefits
|
|
|
|
{{< admonition type="note" >}}
|
|
SCIM provisioning only works SAML authentication.
|
|
Other authentication methods aren't supported.
|
|
{{< /admonition >}}
|
|
|
|
SCIM offers several advantages for managing users and teams in Grafana:
|
|
|
|
- **Automated user provisioning**: Automatically create, update, and disable users in Grafana when changes occur in your identity provider
|
|
- **Automated team lifecycle management**: Automatically create teams when new groups are added, update team memberships, and delete teams when groups are removed from your identity provider
|
|
- **Reduced administrative overhead**: Eliminate manual user management tasks and reduce the risk of human error
|
|
- **Enhanced security**: Automatically disable access when users leave your organization
|
|
|
|
## Authentication and access requirements
|
|
|
|
When you enable SCIM in Grafana, the following requirements and restrictions apply:
|
|
|
|
1. **Use the same identity provider**: You must use the same identity provider for both authentication and user provisioning. For example, if you use Azure AD for SCIM, you must also use Azure AD for authentication.
|
|
|
|
2. **Authentication restrictions**:
|
|
|
|
- Users attempting to log in through other methods (LDAP, OAuth) will be blocked
|
|
- By default, users who are not provisioned through SCIM cannot access Grafana
|
|
- You can allow non-SCIM users by setting `allow_non_provisioned_users = true`
|
|
|
|
3. **Exceptions**: Users with Basic Auth credentials and those using their Grafana Cloud accounts can still log in regardless of these restrictions.
|
|
|
|
## Configure SCIM in Grafana
|
|
|
|
The table below describes all SCIM configuration options. Like any other Grafana configuration, you can apply these options as [environment variables](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#override-configuration-with-environment-variables).
|
|
|
|
| Setting | Required | Description | Default |
|
|
| ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
|
|
| `user_sync_enabled` | Yes | Enable SCIM user provisioning. When enabled, Grafana will create, update, and deactivate users based on SCIM requests from your identity provider. | `false` |
|
|
| `group_sync_enabled` | No | Enable SCIM group provisioning. When enabled, Grafana will create, update, and delete teams based on SCIM requests from your identity provider. Cannot be enabled if Team Sync is enabled. | `false` |
|
|
| `allow_non_provisioned_users` | No | Allow non SCIM provisioned users to sign in to Grafana. | `false` |
|
|
|
|
{{< admonition type="warning" >}}
|
|
**Team Sync Compatibility**:
|
|
|
|
- SCIM group sync (`group_sync_enabled = true`) and Team Sync cannot be enabled simultaneously
|
|
- You can use SCIM user sync (`user_sync_enabled = true`) alongside Team Sync
|
|
- For more details about migration and compatibility, see [SCIM vs Team Sync](./manage-users-teams/_index.md#scim-vs-team-sync)
|
|
{{< /admonition >}}
|
|
|
|
### Example SCIM configuration
|
|
|
|
```ini
|
|
[auth.scim]
|
|
user_sync_enabled = true
|
|
group_sync_enabled = false
|
|
```
|
|
|
|
## Supported identity providers
|
|
|
|
The following identity providers are supported:
|
|
|
|
- [Azure AD](../configure-authentication/azuread/)
|
|
- [Okta](../configure-authentication/saml/)
|
|
|
|
## How it works
|
|
|
|
The synchronization process works as follows:
|
|
|
|
1. Configure SCIM in both your identity provider and Grafana
|
|
2. Your identity provider sends SCIM requests to the Grafana SCIM API endpoint
|
|
3. Grafana processes these requests to create, update, or deactivate users and teams, and synchronize team memberships
|
|
|
|
## Comparison with other sync methods
|
|
|
|
Grafana offers several methods for synchronizing users, teams, and roles.
|
|
The following table compares SCIM with other synchronization methods to help you understand the advantages:
|
|
|
|
| Sync Method | Users | Teams | Roles | Automation | Key Benefits | Limitations | On-Prem | Cloud |
|
|
| ------------------------------------------------------------------------------ | ----- | ----- | ----- | ---------- | ------------------------------------------------------------------------ | ------------------------------------------------------------ | ------- | ----- |
|
|
| SCIM | ✅ | ✅ | ⚠️ | Full | Complete user and team lifecycle management with automatic team creation | Requires SAML authentication; uses Role Sync for basic roles | ✅ | ✅ |
|
|
| [Team Sync](../configure-team-sync/) | ❌ | ⚠️ | ❌ | Partial | Syncs team memberships to existing teams | Requires manual team creation; no team lifecycle management | ✅ | ✅ |
|
|
| [Active LDAP Sync](../configure-authentication/enhanced-ldap/) | ✅ | ❌ | ❌ | Full | Background synchronization of LDAP users | Limited to LDAP environments | ✅ | ❌ |
|
|
| [Role Sync](../configure-authentication/saml#configure-role-sync) | ❌ | ❌ | ✅ | Full | Full automation of basic role assignment | Limited to basic roles only | ✅ | ✅ |
|
|
| [Org Mapping](../configure-authentication/saml#configure-organization-mapping) | ❌ | ❌ | ⚠️ | Full | Full automation of basic role assignment per organization | Limited to basic roles only; on-premises only | ⚠️ | ❌ |
|
|
|
|
### Key advantages
|
|
|
|
- **Comprehensive user and team automation**: SCIM provides full automation for user and team provisioning, while role management is handled separately through Role Sync
|
|
- **Dynamic team creation**: Teams are created automatically based on identity provider groups
|
|
- **Near real-time synchronization**: Changes in the identity provider are reflected based on the provider synchronization schedule
|
|
- **Enterprise-ready**: Designed for large organizations with complex user management needs
|
|
|
|
## Next steps
|
|
|
|
- [Manage users and teams with SCIM provisioning](manage-users-teams/)
|
|
- [Configure SCIM with Azure AD](azuread/)
|
|
- [Configure SCIM with Okta](okta/)
|