PUT /superAdmin/{product}/mfa – Updates Super Admin MFA requirement for a specific product.


Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • enabled: boolean (required) - Whether MFA is required for Super Admins
  • tenantList: string[] (optional) - List of test tenants that bypass MFA requirement

Path Parameters:

  • product: ProductKey (required) - The product identifier (CTS, EGRANTS, etc.)

Query Parameters:

  • None

  • 200 OK – Returns the Super Admin MFA configuration (updated or unchanged).
  • 201 Created – Returns the newly created Super Admin MFA configuration (if none existed).

Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
500 Internal Server Error Unexpected error during update
{
"error": "Detailed error message here"
}

PUT /superAdmin/CTS/mfa
{
"enabled": true,
"tenantList": ["tenant1", "tenant2"]
}
PUT /superAdmin/CTS/mfa
{
"enabled": false,
"tenantList": ["test-tenant-1", "test-tenant-2"]
}
{
"product": "CTS",
"enabled": false,
"tenantList": ["test-tenant-1", "test-tenant-2"],
"updatedAt": "2025-10-03T15:30:00.000Z",
"expiresAt": 1728055800
}

  • The endpoint performs change detection before updating the database
  • If no changes are detected (same enabled value and tenantList), no database write occurs
  • This prevents unnecessary TTL resets and improves performance
  • Always returns the current configuration, whether updated or not

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.