grafana/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md

aliases	description	keywords	title	weight
../../../auth/github/	Grafana OAuthentication Guide	grafana configuration documentation oauth	Configure GitHub OAuth2 authentication	1400

Configure GitHub OAuth2 authentication

To enable the GitHub OAuth2 you must register your application with GitHub. GitHub will generate a client ID and secret key for you to use.

Configure GitHub OAuth application

You need to create a GitHub OAuth application (you will find this under the GitHub settings page). When you create the application you will need to specify a callback URL. Specify this as callback:

http://<my_grafana_server_name_or_ip>:<grafana_server_port>/login/github

Note: <my_grafana_server_name_or_ip>'s value should match your grafana server's root_url, the URL used to access grafana.

This callback URL must match the full HTTP address that you use in your browser to access Grafana, but with the suffix path of /login/github. When the GitHub OAuth application is created you will get a Client ID and a Client Secret. Specify these in the Grafana configuration file. For example:

Enable GitHub in Grafana

[auth.github]
enabled = true
allow_sign_up = true
auto_login = false
client_id = YOUR_GITHUB_APP_CLIENT_ID
client_secret = YOUR_GITHUB_APP_CLIENT_SECRET
scopes = user:email,read:org
auth_url = https://github.com/login/oauth/authorize
token_url = https://github.com/login/oauth/access_token
api_url = https://api.github.com/user
team_ids =
allowed_organizations =

You may have to set the root_url option of [server] for the callback URL to be correct. For example in case you are serving Grafana behind a proxy.

Restart the Grafana back-end. You should now see a GitHub login button on the login page. You can now login or sign up with your GitHub accounts.

You may allow users to sign-up via GitHub authentication by setting the allow_sign_up option to true. When this option is set to true, any user successfully authenticating via GitHub authentication will be automatically signed up.

You can also use [variable expansion]({{< relref "../../../configure-grafana#variable-expansion" >}}) to reference environment variables and local files in your GitHub auth configuration.

GitHub refresh token

Available in Grafana v9.3 and later versions.

Note: This feature is behind the accessTokenExpirationCheck feature toggle.

GitHub OAuth applications do not support refresh tokens because the provided access tokens do not expire.

team_ids

Require an active team membership for at least one of the given teams on GitHub. If the authenticated user isn't a member of at least one of the teams they will not be able to register or authenticate with your Grafana instance. For example:

[auth.github]
enabled = true
allow_sign_up = true
auto_login = false
client_id = YOUR_GITHUB_APP_CLIENT_ID
client_secret = YOUR_GITHUB_APP_CLIENT_SECRET
scopes = user:email,read:org
team_ids = 150,300
auth_url = https://github.com/login/oauth/authorize
token_url = https://github.com/login/oauth/access_token
api_url = https://api.github.com/user

allowed_organizations

Require an active organization membership for at least one of the given organizations on GitHub. If the authenticated user isn't a member of at least one of the organizations they will not be able to register or authenticate with your Grafana instance. For example

[auth.github]
enabled = true
allow_sign_up = true
auto_login = false
client_id = YOUR_GITHUB_APP_CLIENT_ID
client_secret = YOUR_GITHUB_APP_CLIENT_SECRET
scopes = user:email,read:org
auth_url = https://github.com/login/oauth/authorize
token_url = https://github.com/login/oauth/access_token
api_url = https://api.github.com/user
# space-delimited organization names
allowed_organizations = github google

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

Map roles

You can use GitHub OAuth to map roles. During mapping, Grafana checks for the presence of a role using the JMESPath specified via the role_attribute_path configuration option.

For the path lookup, Grafana uses JSON obtained from querying GitHub's API /api/user endpoint and a groups key containing all of the user's teams (retrieved from /api/user/teams).

The result of evaluating the role_attribute_path JMESPath expression must be a valid Grafana role, for example, Viewer, Editor or Admin. For more information about roles and permissions in Grafana, refer to [Roles and permissions]({{< relref "../../../../administration/roles-and-permissions" >}}).

{{% admonition type="warning" %}} Currently if no organization role mapping is found for a user, Grafana doesn't update the user's organization role. This is going to change in Grafana 10. To avoid overriding manually set roles, enable the skip_org_role_sync option in the [auth.github] section. See [Configure Grafana]({{< relref "../../../configure-grafana#authgithub" >}}) for more information. {{% /admonition %}}

On first login, if therole_attribute_path property does not return a role, then the user is assigned the role specified by [the auto_assign_org_role option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). You can disable this default role assignment by setting role_attribute_strict = true. It denies user access if no role or an invalid role is returned.

{{% admonition type="warning" %}} With Grafana 10, on every login, if therole_attribute_path property does not return a role, then the user is assigned the role specified by [the auto_assign_org_role option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). {{% /admonition %}}

An example Query could look like the following:

role_attribute_path = [login==octocat] && 'Admin' || 'Viewer'

This allows the user with login "octocat" to be mapped to the Admin role, but all other users to be mapped to the Viewer role.

Map roles using teams

Teams can also be used to map roles. For instance, if you have a team called 'example-group' you can use the following snippet to ensure those members inherit the role 'Editor'.

role_attribute_path = contains(groups[*], '@my-github-organization/my-github-team') && 'Editor' || 'Viewer'

Note: If a match is found in other fields, teams will be ignored.

Map server administrator privileges

Available in Grafana v9.2 and later versions.

If the application role received by Grafana is GrafanaAdmin, Grafana grants the user server administrator privileges.
This is useful if you want to grant server administrator privileges to a subset of users.
Grafana also assigns the user the Admin role of the default organization.

The setting allow_assign_grafana_admin under [auth.github] must be set to true for this to work.
If the setting is set to false, the user is assigned the role of Admin of the default organization, but not server administrator privileges.

allow_assign_grafana_admin = true

Example:

role_attribute_path = [login==octocat] && 'GrafanaAdmin' || 'Viewer'

Team Sync (Enterprise only)

Only available in Grafana Enterprise v6.3+

With Team Sync you can map your GitHub org teams to teams in Grafana so that your users will automatically be added to the correct teams.

Your GitHub teams can be referenced in two ways:

• https://github.com/orgs/<org>/teams/<slug>
• @<org>/<slug>

Example: @grafana/developers

[Learn more about Team Sync]({{< relref "../../configure-team-sync" >}})

Skip organization role sync

To prevent the sync of organization roles from GitHub, set skip_org_role_sync to true. This is useful if you want to manage the organization roles for your users from within Grafana. This also impacts the allow_assign_grafana_admin setting by not syncing the Grafana admin role from GitHub.

[auth.github]
# ..
# prevents the sync of org roles from Github
skip_org_role_sync = true
``