Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Configure Grafana authentication
Grafana of course has a built in user authentication system with password authentication enabled by default. You can disable authentication by enabling anonymous access. You can also hide login form and only allow login through an auth provider (listed above). There is also options for allowing self sign up.
Login and short-lived tokens
The following applies when using Grafana’s built in user authentication, LDAP (without Auth proxy) or OAuth integration.
Grafana uses short-lived tokens as a mechanism for verifying authenticated users.
These short-lived tokens are rotated each token_rotation_interval_minutes
for an active authenticated user.
An active authenticated user that gets it token rotated will extend the login_maximum_inactive_lifetime_duration
time from “now” that Grafana will remember the user.
This means that a user can close its browser and come back before now + login_maximum_inactive_lifetime_duration
and still being authenticated.
This is true as long as the time since user login is less than login_maximum_lifetime_duration
.
Remote logout
You can logout from other devices by removing login sessions from the bottom of your profile page. If you are a Grafana admin user you can also do the same for any user from the Server Admin / Edit User view.
Settings
Example:
[auth]
# Login cookie name
login_cookie_name = grafana_session
# The lifetime (days) an authenticated user can be inactive before being required to login at next visit. Default is 7 days.
login_maximum_inactive_lifetime_duration = 7d
# The maximum lifetime (days) an authenticated user can be logged in since login time before being required to login. Default is 30 days.
login_maximum_lifetime_duration = 30d
# How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
token_rotation_interval_minutes = 10
# The maximum lifetime (seconds) an api key can be used. If it is set all the api keys should have limited lifetime that is lower than this value.
api_key_max_seconds_to_live = -1
Anonymous authentication
You can make Grafana accessible without any login required by enabling anonymous access in the configuration file. For more information, refer to Implications of allowing anonymous access to dashboards.
Example:
[auth.anonymous]
enabled = true
# Organization name that should be used for unauthenticated users
org_name = Main Org.
# Role for unauthenticated users, other valid values are `Editor` and `Admin`
org_role = Viewer
# Hide the Grafana version text from the footer and help tooltip for unauthenticated users (default: false)
hide_version = true
If you change your organization name in the Grafana UI this setting needs to be updated to match the new name.
Basic authentication
Basic auth is enabled by default and works with the built in Grafana user password authentication system and LDAP authentication integration.
To disable basic auth:
[auth.basic]
enabled = false
Disable login form
You can hide the Grafana login form using the below configuration settings.
[auth]
disable_login_form = true
Automatic OAuth login
Set to true to attempt login with specific OAuth provider automatically, skipping the login screen.
This setting is ignored if multiple auth providers are configured to use auto login.
Defaults to false
.
[auth.generic_oauth]
auto_login = true
Hide sign-out menu
Set the option detailed below to true to hide sign-out menu link. Useful if you use an auth proxy or JWT authentication.
[auth]
disable_signout_menu = true
URL redirect after signing out
URL to redirect the user to after signing out from Grafana. This can for example be used to enable signout from oauth provider.
[auth]
signout_redirect_url =
Protected roles
Note: Available in Grafana Enterprise and Grafana Cloud Advanced.
By default, after you configure an authorization provider, Grafana will adopt existing users into the new authentication scheme. For example, if you have created a user with basic authentication having the login jsmith@example.com
, then set up SAML authentication where jsmith@example.com
is an account, the user’s authentication type will be changed to SAML if they perform a SAML sign-in.
You can disable this user adoption for certain roles using the protected_roles
property:
[auth.security]
protected_roles = server_admins org_admins
The value of protected_roles
should be a list of roles to protect, separated by spaces. Valid roles are viewers
, editors
, org_admins
, server_admins
, and all
(a superset of the other roles).