Skip to main content

Microsoft Authentication

Velero UI also supports authentication via Microsoft using OAuth 2.0. This guide explains how to configure and enable Microsoft authentication using environment variables.

Environment Variables​

VariableDescription
MICROSOFT_AUTH_ENABLEDSet to true to enable Microsoft authentication. Default is false.
MICROSOFT_CLIENT_IDThe client ID from your Microsoft Azure portal.
MICROSOFT_CLIENT_SECRETThe client secret from your Microsoft Azure portal.
MICROSOFT_OAUTH_SCOPEThe scope of OAuth access. Default: user.read.
MICROSOFT_REDIRECT_URIThe redirect URI after authentication. Default: http://localhost:4200/login.
MICROSOFT_TENANTThe Microsoft tenant ID. Use common for multi-tenant applications.

Steps to Configure Microsoft Authentication​

  1. Register an Application in Azure AD

    • Go to the Azure Portal.
    • Navigate to Azure Active Directory > App registrations.
    • Click New registration.
    • Set the Redirect URI to http://localhost:4200/login (or your production URL).
    • Copy the Application (client) ID and Directory (tenant) ID.

  2. Create a Client Secret

    • In your registered application, go to Certificates & secrets.
    • Click New client secret, set an expiration period, and copy the generated secret.

  3. Set Environment Variables

    • Update your environment variables with the values from Azure AD.
    • Example: 
      MICROSOFT_AUTH_ENABLED=true
      MICROSOFT_CLIENT_ID=your-client-id
      MICROSOFT_CLIENT_SECRET=your-client-secret
      MICROSOFT_OAUTH_SCOPE="user.read"
      MICROSOFT_REDIRECT_URI=http://localhost:4200/login
      MICROSOFT_TENANT=common

  4. Restart Your Application

    • Restart the Velero UI to apply the changes.

Troubleshooting​

  • Ensure that the redirect URI set in Azure matches MICROSOFT_REDIRECT_URI.
  • Check if MICROSOFT_AUTH_ENABLED is set to true.
  • Inspect logs for authentication errors.
  • Verify that your Microsoft OAuth credentials are correct.

Conclusion​

Once configured, users will be able to sign in to Velero UI using their Microsoft accounts via OAuth 2.0 authentication.