mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 16:12:14 +08:00
11997a6d35
* Update Grafana.com org sync index.md Included additional information regarding logging in with Grafana.com credentials that it will override what is defined within the Grafana instance. * Update docs/sources/setup-grafana/configure-security/configure-authentication/grafana-com/index.md Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --------- Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com> Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
---
|
|
aliases:
|
|
- ../../../auth/grafana-com/
|
|
description: Grafana Com Authentication
|
|
labels:
|
|
products:
|
|
- cloud
|
|
menuTitle: Grafana Com OAuth2
|
|
title: Configure Grafana Com authentication
|
|
weight: 1200
|
|
---
|
|
|
|
# Configure Grafana Com authentication
|
|
|
|
To enable GrafanaCom as your authentication provider, you configure it to generate a client ID and a secret key.
|
|
|
|
## Create GrafanaCom OAuth keys
|
|
|
|
To use GrafanaCom authentication:
|
|
|
|
1. Log in to [GrafanaCom](/).
|
|
1. To create an OAuth client, locate your organization and click **OAuth Clients**.
|
|
1. Click **Add OAuth Client Application**.
|
|
1. Add the name and URL of your running Grafana instance.
|
|
1. Click **Add OAuth Client**.
|
|
1. Copy the client ID and secret key or the configuration that has been generated.
|
|
|
|
The following snippet shows an example configuration:
|
|
|
|
```ini
|
|
[auth.grafana_com]
|
|
enabled = true
|
|
allow_sign_up = true
|
|
auto_login = false
|
|
client_id = 450bc21c10dc2194879d
|
|
client_secret = eyJ0Ijoib2F1dGgyYyIhlmlkIjoiNzUwYmMzM2MxMGRjMjE6NDh3OWQiLCJ2IjoiZmI1YzVlYmIwYzFmN2ZhYzZmNjIwOGI1NmVkYTRlNWYxMzgwM2NkMiJ9
|
|
scopes = user:email
|
|
allowed_organizations = sampleorganization
|
|
enabled = true
|
|
```
|
|
|
|
### Configure automatic login
|
|
|
|
Set `auto_login` option to true to attempt login automatically, skipping the login screen.
|
|
This setting is ignored if multiple auth providers are configured to use auto login.
|
|
|
|
```
|
|
auto_login = true
|
|
```
|
|
|
|
## Skip organization role sync
|
|
|
|
If a user signs in with their Grafana.com credentials, their assigned org role overrides the role defined in the Grafana instance. To prevent Grafana.com roles from synchronizing, set `skip_org_role_sync` to `true`. This is useful if you want to manage the organization roles for your users from within Grafana.
|
|
|
|
```ini
|
|
[auth.grafana_com]
|
|
# ..
|
|
# prevents the sync of org roles from Grafana.com
|
|
skip_org_role_sync = true
|
|
```
|