Skip to main content

Authentication Overview

The Mimeeq authentication library provides a comprehensive identity and access management solution for your Mimeeq-powered applications. The mimeeqAuth object (accessible globally via window) enables secure user authentication, session management, and fine-grained access control with minimal development effort.

Key Features​

  • Complete Authentication Flows - Sign in, sign out, and password recovery workflows built-in
  • Pre-built UI Components - Ready-to-use login forms, user profile management, and password reset interfaces
  • Secure Token Management - Automatic handling of authentication tokens for API requests
  • Enterprise-grade Security - Integration with AWS Cognito for industry-standard identity management
  • Multi-customer Support - Customer-specific authentication contexts for complex business environments
warning

To use the authentication functionality, you must add the mmq-auth element to your site. This element is required for all authentication methods to work properly. You can find the required code snippet in the Admin Panel under Settings → Login Code.

Authentication URL​

For a frictionless authentication experience, you can use a direct authentication URL that automatically opens the login modal:

https://your-domain.com/?auth=mimeeq

The authentication system will intelligently handle the session state and display either the login form or logout prompt based on whether the user is currently authenticated.

You can also trigger the login/logout modal programmatically by adding a simple link to your page:

<a href="?auth=mimeeq">Login / My Account</a>

Working with the Authentication API​

The authentication library loads asynchronously to prevent blocking page rendering. This means the mimeeqAuth object isn't immediately available after page load. To ensure the library is fully loaded before you use it, listen for the mimeeq-auth-loaded event:

document.addEventListener('mimeeq-auth-loaded', () => {
  // Initialize authentication using the global environment config
  const { cognitoConfig, s3Config, appSyncConfig } = window.mimeeqEmbedEnv;
  window.mimeeqAuth.initialize(cognitoConfig, s3Config, appSyncConfig);

  // Now you can safely interact with the authentication API
  mimeeqAuth.authorization.getUserData().then((user) => {
    if (user && !('name' in user)) {
      console.log('User is logged in:', user);
      // Update UI for authenticated state
    } else {
      console.log('No user is currently logged in');
      // Show login options
    }
  });
});
tip

When using the <mmq-auth> or <mmq-embed> components, initialization is handled automatically using the global window.mimeeqEmbedEnv configuration, so you typically don't need to call initialize() yourself.