Docs: Clarify disabling auto login for SAML and OAuth (#96520)

This commit is contained in:
Vardan Torosyan 2024-11-15 14:46:03 +01:00 committed by GitHub
parent f31d3f424c
commit 97103a5256
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -159,10 +159,19 @@ Defaults to `false`.
auto_login = true auto_login = true
``` ```
### Avoid automatic OAuth login ### Avoid automatic login
To sign in with a username and password and avoid automatic OAuth login, add the `disableAutoLogin` parameter to your login URL. The `disableAutoLogin=true` URL parameter allows users to bypass the automatic login feature in scenarios where incorrect configuration changes prevent normal login functionality.
For example: `grafana.example.com/login?disableAutoLogin` or `grafana.example.com/login?disableAutoLogin=true` This feature is especially helpful when you need to access the login screen to troubleshoot and fix misconfigurations.
#### How to use
1. Add `disableAutoLogin=true` as a query parameter to your Grafana URL.
- Example: `grafana.example.net/login?disableAutoLogin=true` or `grafana.example.net/login?disableAutoLogin`
1. This will redirect you to the standard login screen, bypassing the automatic login mechanism.
1. Fix any configuration issues and test your login setup.
This feature is available for both for OAuth and SAML. Ensure that after fixing the issue, you remove the parameter or revert the configuration to re-enable the automatic login feature, if desired.
### Hide sign-out menu ### Hide sign-out menu