Auth Module

v2.0.1

Module

Essential module for user authentication and identity management. Provides secure login, registration, and account management capabilities.

Required Module

for community, financial, and e-commerce entities

Required For

Optional For

Auth Methods

Social Providers

Module Purpose & Benefits

The Auth module provides comprehensive authentication capabilities, enabling AI systems to understand how users can securely access and interact with web platforms and services.

Multiple Authentication Methods

Support for email, phone, social login, SSO, and biometric authentication

Social Provider Integration

Built-in support for Google, Facebook, Apple, and other major providers

Security Features

Password policies, login attempt limits, and session management

Account Management

Password reset, email verification, and account recovery features

Two-Factor Authentication

Enhanced security with 2FA support for sensitive accounts

Session Control

Configurable session timeouts and remember me functionality

Required For

Entities that must include the auth module

Required

SocialNetwork

Required for social networking platforms

User accounts essential for social interactions and content

Required

DatingPlatform

Required for dating and relationship platforms

User profiles and identity verification critical for safety

Required

OnlineBanking

Required for financial services

Secure authentication mandatory for financial transactions

Required

EcommerceStore

Required for e-commerce platforms

User accounts needed for order history and payments

Required

Marketplace

Required for marketplace platforms

Both buyers and sellers need authenticated accounts

Required

GenerativeAIPlatform

Required for AI service platforms

User authentication needed for service usage tracking

Optional For

Entities that may benefit from authentication features

Optional

Hotel

Optional

Restaurant

Optional

Clinic

Optional

Education Platform

Optional

Fitness Platform

Optional

Real Estate Platform

Optional

Task Management App

Optional

Virtual Event Platform

Supported Authentication Methods

Different ways users can authenticate with the platform

Traditional email and password authentication

phone

SMS or phone-based authentication

social

OAuth authentication via social media platforms

sso

Single Sign-On integration with enterprise systems

biometric

Fingerprint, face recognition, or other biometric methods

magic_link

Passwordless authentication via email links

Social Authentication Providers

External authentication services supported by the platform

local

Platform's own authentication system

google

Google OAuth authentication

facebook

Facebook Login integration

apple

twitter

Twitter OAuth authentication

LinkedIn professional authentication

github

GitHub OAuth for developers

microsoft

Microsoft Account authentication

Module Schema

Complete auth module structure and properties

auth.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Auth Module",
  "description": "Module for authentication and user identity management",
  "aimlVersion": "2.0.1",
  "schemaVersion": "2.0.1",
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "const": "2.0.1",
      "description": "Module version"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether auth module is enabled"
    },
    "methods": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["email", "phone", "social", "sso", "biometric", "magic_link"]
      },
      "description": "Supported authentication methods"
    },
    "providers": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["local", "google", "facebook", "apple", "twitter", "linkedin", "github", "microsoft"]
      },
      "description": "Authentication providers available"
    },
    "features": {
      "type": "object",
      "properties": {
        "hasPasswordReset": { "type": "boolean" },
        "hasEmailVerification": { "type": "boolean" },
        "hasTwoFactorAuth": { "type": "boolean" },
        "hasRememberMe": { "type": "boolean" },
        "hasSessionTimeout": { "type": "boolean" },
        "hasLoginAttemptLimit": { "type": "boolean" }
      },
      "description": "Authentication features available"
    },
    "security": {
      "type": "object",
      "properties": {
        "passwordMinLength": { "type": "integer", "minimum": 4 },
        "sessionTimeoutMinutes": { "type": "integer", "minimum": 5 },
        "maxLoginAttempts": { "type": "integer", "minimum": 1 },
        "requireEmailVerification": { "type": "boolean" },
        "encryptPasswords": { "type": "boolean" }
      }
    }
  },
  "required": ["version", "enabled", "methods"],
  "additionalProperties": true
}

Implementation Example

Social network entity with comprehensive authentication configuration

Social Network with auth module

{
  "modules": {
    "auth": {
      "version": "2.0.1",
      "enabled": true,
      "methods": ["email", "social", "phone"],
      "providers": ["local", "google", "facebook"],
      "features": {
        "hasPasswordReset": true,
        "hasEmailVerification": true,
        "hasTwoFactorAuth": true,
        "hasRememberMe": true,
        "hasSessionTimeout": true,
        "hasLoginAttemptLimit": true
      },
      "security": {
        "passwordMinLength": 8,
        "sessionTimeoutMinutes": 30,
        "maxLoginAttempts": 5,
        "requireEmailVerification": true,
        "encryptPasswords": true
      }
    }
  }
}

Security Configuration

Built-in security features and policies

hasPasswordReset

Users can reset forgotten passwords via secure links

hasEmailVerification

Email addresses must be verified before account activation

hasTwoFactorAuth

Additional security layer with 2FA for sensitive accounts

hasSessionTimeout

Automatic logout after period of inactivity

hasLoginAttemptLimit

Protection against brute force attacks with attempt limits

hasRememberMe

Users can stay logged in across browser sessions

Module URL

Direct access to the auth module schema

https://schemas.meta-aiml.org/v2.0.1/templates/module/auth.json

Included in entity schemas via the modules object

← All Modules Enhanced Auth Module →Social Network Entity →