Tenant Maintenance Mode

Last updated: Dec 4, 2024

Overview

This article explains whether it is possible to set a tenant to a “maintenance mode,” which means the tenant will deflect all requests.

Applies To

  • Auth0 Tenants
  • Maintenance Mode

Solution

Setting a tenant to “maintenance mode” is not supported at this moment.

However, Login and/or Signup requests can be denied using api.access.deny method in Actions.

The client_metadata can be used to flag a specific application is in maintenance: Configure Application Metadata

For example, in a Post Login Action:

if(event.client.metadata.mode === "maintenance") {

api.access.deny("Maintenance Mode")

}


Note: This use case is not officially supported. Please do robust testing / and perform a proof of concept (PoC) before taking this approach. End users can hit the API endpoints or start a password reset process even if a Post Login Action denies the requests. The example code only denies the login request.