mimeeqAuth

The Web API object that provides comprehensive authentication services for Mimeeq Embed applications.

mimeeqAuth is the central authentication module for the Mimeeq platform, enabling user authentication, session management, and access control. It exposes methods to authenticate users against customer accounts, manage password recovery, and display authentication-related UI components.

In most implementations, this module works in conjunction with the global window.mimeeqEmbedEnv configuration, which provides necessary settings for AWS Cognito, S3, and AppSync. When using the <mmq-auth> or <mmq-embed> components, the initialization and configuration is handled automatically.

Key Features:

• Complete authentication flow (sign in, sign out, password recovery)
• Pre-built UI components for login, user profile, and password reset
• Token management for authenticated API requests
• Integration with AWS Cognito for secure identity management
• Multi-customer support with customer-specific authentication

This module serves as a secure gateway to Mimeeq's product configuration capabilities, ensuring that only authorized users can access protected features and customer data.

You can access any of the methods or properties using the global window.mimeeqAuth object after the mimeeqAuth.min.js script has been loaded on your page.

IMPORTANT: The library loads asynchronously, so the mimeeqAuth object is not immediately available after page load. To ensure the library is loaded before using it, listen for the mimeeq-auth-loaded event.

Example

// Using with the mmq-auth component (recommended approach):
// <mmq-auth short-code="your-short-code"></mmq-auth>

// For custom implementations, wait for authentication library to load:
document.addEventListener('mimeeq-auth-loaded', () => {
  // Initialize authentication using the global environment config
  const { cognitoConfig, s3Config, appSyncConfig } = window.mimeeqEmbedEnv;
  window.mimeeqAuth.initialize(cognitoConfig, s3Config, appSyncConfig);

  // Check if user is already logged in
  window.mimeeqAuth.authorization.getUserData()
    .then(user => {
      if (user) {
        console.log('User is logged in:', user);
      } else {
        // Display login dialog if not logged in
        window.mimeeqAuth.mountLogin({
          onLoginSuccess: (user) => console.log('User logged in:', user)
        });
      }
    });
});

Variables

mimeeqAuth

const mimeeqAuth: MimeeqAuth