grafana/docs/sources/auth/azuread.md

+++ title = "Azure AD OAuth2 authentication" description = "Grafana Azure AD OAuth Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] type = "docs" [menu.docs] name = "Azure AD" identifier = "azuread_oauth2" parent = "authentication" weight = 3 +++

Azure AD OAuth2 authentication

Only available in Grafana v6.7+

The Azure AD authentication provides the possibility to use an Azure Active Directory tenant as an identity provider for Grafana. By using Azure AD Application Roles it is also possible to assign Users and Groups to Grafana roles from the Azure Portal.

Create the Azure AD application

To enable the Azure AD OAuth2 you must register your application with Azure AD.

1. Log in to Azure Portal and click Azure Active Directory in the side menu.

2. Click App Registrations and add a new application registration:

   • Name: Grafana
   • Application type: Web app / API
   • Sign-on URL: https://<grafana domain>/login/azuread

3. Click the name of the new application to open the application details page.

4. Click Endpoints.

   • Note down the OAuth 2.0 authorization endpoint (v2), this will be the auth url.
   • Note down the OAuth 2.0 token endpoint (v2), this will be the token url.

5. Close the Endpoints page to come back to the application details page.

6. Note down the "Application ID", this will be the OAuth client id.

7. Click Certificates & secrets and add a new entry under Client secrets.

   • Description: Grafana OAuth
   • Expires: Never

8. Click Add then copy the key value, this will be the OAuth client secret.

9. Click Manifest.

   • Add definitions for the required Application Roles for Grafana (Viewer, Editor, Admin). Without this configuration all users will be assigned to the Viewer role.

   • Every role has to have a unique id. On Linux this can be created with uuidgen for instance.

     "appRoles": [
     		{
     			"allowedMemberTypes": [
     				"User"
     			],
     			"description": "Grafana admin Users",
     			"displayName": "Grafana Admin",
     			"id": "SOME_UNIQUE_ID",
     			"isEnabled": true,
     			"lang": null,
     			"origin": "Application",
     			"value": "Admin"
     		},
     		{
     			"allowedMemberTypes": [
     				"User"
     			],
     			"description": "Grafana read only Users",
     			"displayName": "Grafana Viewer",
     			"id": "SOME_UNIQUE_ID",
     			"isEnabled": true,
     			"lang": null,
     			"origin": "Application",
     			"value": "Viewer"
     		},
     		{
     			"allowedMemberTypes": [
     				"User"
     			],
     			"description": "Grafana Editor Users",
     			"displayName": "Grafana Editor",
     			"id": "SOME_UNIQUE_ID",
     			"isEnabled": true,
     			"lang": null,
     			"origin": "Application",
     			"value": "Editor"
     		}
     	],
     

10. Click Overview and then on Managed application in local directory to show the Enterprise Application details.

11. Click on Users and groups and add Users/Groups to the Grafana roles by using Add User.

Enable Azure AD OAuth in Grafana

1. Add the following to the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}):

[auth.azuread]
name = Azure AD
enabled = true
allow_sign_up = true
client_id = APPLICATION_ID
client_secret = CLIENT_SECRET
scopes = openid email profile
auth_url = https://login.microsoftonline.com/TENANT_ID/oauth2/v2.0/authorize
token_url = https://login.microsoftonline.com/TENANT_ID/oauth2/v2.0/token
allowed_domains =
allowed_groups =

Note: Ensure that the [root_url]({{< relref "../installation/configuration/#root-url" >}}) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs)

Configure allowed groups and domains

To limit access to authenticated users that are members of one or more groups, set allowed_groups to a comma- or space-separated list of group Object Ids. Object Id for a specific group can be found on the Azure portal: go to Azure Active Directory -> Groups. For instance, if you want to only give access to members of the group example which has Id 8bab1c86-8fba-33e5-2089-1d1c80ec267d, set

allowed_groups = 8bab1c86-8fba-33e5-2089-1d1c80ec267d

You'll need to ensure that you've enabled group attributes in your Azure AD Application Registration manifest file (Azure Portal -> Azure Active Directory -> Application Registrations -> Select Application -> Manifest)

"groupMembershipClaims": "ApplicationGroup"

The allowed_domains option limits access to the users belonging to the specific domains. Domains should be separated by space or comma.

allowed_domains = mycompany.com mycompany.org

Team Sync (Enterprise only)

Only available in Grafana Enterprise v6.7+

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

Azure AD groups can be referenced by group Object Id, like 8bab1c86-8fba-33e5-2089-1d1c80ec267d.

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