mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Edited Enterprise docs (#22602)
* Update white-labeling.md * Update team-sync.md * Update saml.md * Update saml.md * Update menu.yaml * Update reporting.md * Update saml.md * Update reporting.md * Update reporting.md * Update enhanced_ldap.md * Update _index.md * content updates content updates * Update menu.yaml * Update datasource_permissions.md * Update _index.md * Minor edits * Update _index.md * Update docs/sources/enterprise/_index.md Co-Authored-By: Emil Tullstedt <sakjur@gmail.com> * Update _index.md * Update saml.md * Update reporting.md Co-authored-by: Emil Tullstedt <sakjur@gmail.com>
This commit is contained in:
@@ -7,41 +7,45 @@ type = "docs"
|
||||
[menu.docs]
|
||||
name = "Team sync"
|
||||
parent = "enterprise"
|
||||
weight = 5
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
# Team sync
|
||||
|
||||
> Only available in Grafana Enterprise.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}}
|
||||
|
||||
With the Team Sync it's possible to setup synchronization between your auth providers teams and teams in Grafana. This enables LDAP or GitHub OAuth users which are members
|
||||
of certain teams/groups to automatically be added/removed as members to certain teams in Grafana. Currently the synchronization will only happen every
|
||||
time a user logs in, unless LDAP is used together with active background synchronization that was added in Grafana 6.3.
|
||||
Team sync lets you set up synchronization between your auth providers teams and teams in Grafana. This enables LDAP or GitHub OAuth users who are members
|
||||
of certain teams or groups to automatically be added or removed as members of certain teams in Grafana.
|
||||
|
||||
Grafana keeps track of all synchronized users in teams and you can see which users have been synchronized in the team members list, see `LDAP` label in screenshot.
|
||||
This mechanism allows Grafana to remove an existing synchronized user from a team when its LDAP group membership (for example) changes. This mechanism also enables you to manually add a user as member of a team and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships.
|
||||
> Only available in Grafana Enterprise.
|
||||
|
||||
Grafana keeps track of all synchronized users in teams, and you can see which users have been synchronized in the team members list, see `LDAP` label in screenshot.
|
||||
This mechanism allows Grafana to remove an existing synchronized user from a team when its group membership changes. This mechanism also enables you to manually add a user as member of a team, and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships.
|
||||
|
||||
> Currently the synchronization only happens when a user logs in, unless LDAP is used with the active background synchronization that was added in Grafana 6.3.
|
||||
|
||||
<div class="clearfix"></div>
|
||||
|
||||
### Enable synchronization for a team
|
||||
## Synchronize a Grafana team with an external group
|
||||
|
||||
If you have already grouped some users into a team, then you can synchronize that team with an external group.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/team_add_external_group.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}}
|
||||
|
||||
1. Navigate to Configuration / Teams.
|
||||
2. Select a team.
|
||||
3. Select the External group sync tab and click on the `Add group` button.
|
||||
4. Insert the value of the group you want to sync with. This becomes what Grafana denominates as a `GroupID`.
|
||||
1. In Grafana, navigate to **Configuration > Teams**.
|
||||
1. Select a team.
|
||||
1. On the External group sync tab, and click **Add group**.
|
||||
1. Insert the value of the group you want to sync with. This becomes the Grafana `GroupID`.
|
||||
Examples:
|
||||
|
||||
- Using LDAP as an example, this is the LDAP distinguished name (DN) of LDAP group you want to synchronize with the team.
|
||||
- Using Auth Proxy as an example, this is the value we receive as part of the custom `Groups` header.
|
||||
- For LDAP, this is the LDAP distinguished name (DN) of LDAP group you want to synchronize with the team.
|
||||
- For Auth Proxy, this is the value we receive as part of the custom `Groups` header.
|
||||
|
||||
5. Click on `Add group` button to save.
|
||||
1. Click `Add group` to save.
|
||||
|
||||
### Supported Providers
|
||||
## Supported providers
|
||||
|
||||
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
|
||||
Reference in New Issue
Block a user