Configure Okta OAuth2 authentication
There are numerous authentication methods available in Grafana to verify user identity. The authentication configuration dictates which users can access Grafana and the methods they can use for logging in. You can also configure Grafana to automatically update users’ roles and team memberships in Grafana based on the information returned by the auth provider integration.
When deciding on an authentication method, it’s important to take into account your current identity and access management system as well as the specific authentication and authorization features you require. For a complete list of the available authentication options and the features they support, refer to Configure authentication.
Before you begin
To follow this guide:
- Ensure that you have access to the Grafana configuration file.
- Ensure you know how to create an OAuth2 application with your OAuth2 provider. Consult the documentation of Okta OAuth2 for more information.
- If you are using refresh tokens, ensure you know how to set them up with your OAuth2 provider. Consult the documentation of your OAuth2 provider for more information.
To integrate your Okta OAuth2 provider with Grafana using our Okta OAuth2 integration, follow these steps:
Set the callback URL for your OAuth2 app to
Ensure that the callback URL is the complete HTTP address that you use to access Grafana via your browser, but with the appended path of
For the callback URL to be correct, it might be necessary to set the root_url option to [server], for example, if you are serving Grafana behind a proxy.
Refer to the following table to update field values located in the
[auth.okta]section of the Grafana configuration file:
These values must match the client ID and client secret from your Okta OAuth2 app.
The authorization endpoint of your OAuth2 provider.
The token endpoint of your Okta OAuth2 provider.
The user information endpoint of your Okta OAuth2 provider.
Enables Okta OAuth2 authentication. Set this value to
Review the list of other Okta OAuth2 configuration options and complete them as necessary.
Optional: Configure a refresh token:
a. Enable the
b. Extend the
[auth.okta]section in Grafana configuration file with the refresh token scope used by your OAuth2 provider.
c. Enable the refresh token at the Okta application settings.
Optional: Configure team synchronization.
You should now see a Okta OAuth2 login button on the login page and be able to log in or sign up with your OAuth2 provider.
The following table outlines the various Okta OAuth2 configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana.
|No||Enables Okta OAuth2 authentication.|
|No||Name that refers to the Okta OAuth2 authentication from the Grafana user interface.|
|No||Icon used for the Okta OAuth2 authentication in the Grafana user interface.|
|Yes||Client ID provided by your Okta OAuth2 app.|
|Yes||Client secret provided by your Okta OAuth2 app.|
|Yes||Authorization endpoint of your Okta OAuth2 provider.|
|Yes||Endpoint used to obtain the Okta OAuth2 access token.|
|Yes||Endpoint used to obtain user information.|
|No||List of comma- or space-separated Okta OAuth2 scopes.|
|No||Controls Grafana user creation through the Okta OAuth2 login. Only existing Grafana users can log in with Okta OAuth2 if set to |
|No||Set to |
|No||JMESPath expression to use for Grafana role lookup. Grafana will first evaluate the expression using the Okta OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (|
|No||Set to |
|No||Set to |
|No||List of comma- or space-separated groups. The user should be a member of at least one group to log in.|
|No||List comma- or space-separated domains. The user should belong to at least one domain to log in.|
|No||Set to |
|No||Set to |
Configure a refresh token
Available in Grafana v9.3 and later versions.
Note: This feature is behind the
When a user logs in using an OAuth provider, Grafana verifies that the access token has not expired. When an access token expires, Grafana uses the provided refresh token (if any exists) to obtain a new access token without requiring the user to log in again.
If a refresh token doesn’t exist, Grafana logs the user out of the system after the access token has expired.
To enable the
Refresh Token head over the Okta application settings and:
Generaltab, find the
- Within the
Grant Typeoptions, enable the
At the configuration file, extend the
[auth.okta] section with
accessTokenExpirationCheckfeature toggle will be removed in Grafana v10.3.0 and the
use_refresh_tokenconfiguration value will be used instead for configuring refresh token fetching and access token expiration check.
Configure role mapping
skip_org_role_syncoption is enabled, the user’s role will be set to the role retrieved from the auth provider upon user login.
The user’s role is retrieved using a JMESPath expression from the
role_attribute_path configuration option against the
api_url endpoint payload.
To map the server administrator role, use the
allow_assign_grafana_admin configuration option.
Refer to configuration options for more information.
If no valid role is found, the user is assigned the role specified by the
You can disable this default role assignment by setting
role_attribute_strict = true.
This setting denies user access if no role or an invalid role is returned.
Configure team synchronization (Enterprise only)
By using Team Sync, you can link your OAuth2 groups to teams within Grafana. This will automatically assign users to the appropriate teams.
Map your Okta groups to teams in Grafana so that your users will automatically be added to the correct teams.
Okta groups can be referenced by group names, like
To learn more about Team Sync, refer to Configure Team Sync.