Two-Factor Authentication
Sairo supports TOTP-based two-factor authentication (2FA) for an additional layer of security on user accounts.
How It Works
Section titled “How It Works”2FA uses the Time-based One-Time Password (TOTP) standard (RFC 6238). After enabling 2FA, users must enter a 6-digit code from their authenticator app in addition to their password when logging in.
Compatible Apps
Section titled “Compatible Apps”Any TOTP-compatible authenticator works with Sairo, including:
- Google Authenticator
- Authy
- 1Password
- Bitwarden
- Microsoft Authenticator
- Raivo OTP
Setting Up 2FA
Section titled “Setting Up 2FA”- Click your username in the sidebar and select Security
- Click Enable Two-Factor Authentication
- Scan the QR code with your authenticator app
- Enter the 6-digit code displayed in the app to confirm setup
- Save the recovery codes displayed on screen
Recovery Codes
Section titled “Recovery Codes”On setup, Sairo generates 10 one-time recovery codes. Each code can be used exactly once in place of a TOTP code if you lose access to your authenticator app.
Store recovery codes in a secure location (password manager, printed copy in a safe). Once all recovery codes are used, you must contact an admin to reset your 2FA.
Logging In with 2FA
Section titled “Logging In with 2FA”- Enter your username and password as usual
- A second screen prompts for a 6-digit code
- Enter the code from your authenticator app or a recovery code
- You are logged in
Admin Reset
Section titled “Admin Reset”If a user loses access to their authenticator app and all recovery codes, an admin can reset their 2FA from the Admin Panel:
- Open the Admin Panel
- Find the user and click their username
- Click Reset 2FA
The user can then log in with just their password and optionally re-enable 2FA.
API Tokens and 2FA
Section titled “API Tokens and 2FA”API tokens bypass 2FA by design. This allows automated workflows (CI/CD pipelines, scripts, integrations) to authenticate without a TOTP code. See API Tokens for details.
2FA with External Authentication
Section titled “2FA with External Authentication”When using OAuth or LDAP, 2FA still applies. After authenticating with the external provider, users with 2FA enabled are prompted for their TOTP code before gaining access.