Documentation

    Documentation

    Documentation

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. /
    2. /Authentication

    2 min listen

    1. /
    2. /Authentication

    2 min listen

    1. /
    2. /Authentication

    2 min listen

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)
    Docs
    API
    Docs
    API
    Docs
    API

    Authentication API

    The Ring Platform uses Auth.js v5 for comprehensive authentication with multiple providers including OAuth, magic links, and crypto wallets.

    Overview

    3 endpoints for authentication management:

    • User authentication and session management
    • Multi-provider OAuth integration
    • Crypto wallet authentication

    Authentication Flow

    Supported Providers

    OAuth Providers

    • Google - Primary OAuth provider
    • Apple - iOS/macOS integration
    • MetaMask - Crypto wallet authentication

    Magic Links

    • Email-based - Passwordless authentication
    • Secure tokens - Time-limited access
    • GDPR compliant - Privacy-first approach

    API Endpoints

    POST /api/auth/signin

    Initiate authentication with specified provider

    POST /api/auth/signout

    Sign out user and invalidate session

    GET /api/auth/session

    Get current user session information

    Implementation Examples

    Server-Side Authentication

    Client-Side Authentication

    Role-Based Access Control

    Role Hierarchy

    Ring Platform uses a hierarchical role system:

    1. VISITOR - Public access only
    2. SUBSCRIBER - Basic platform access
    3. MEMBER - Full platform features
    4. CONFIDENTIAL - Access to confidential entities
    5. ADMIN - Platform administration

    Security Features

    • Auth.js sessions — JWT strategy server-side; browser receives httpOnly session cookie
    • CSRF Protection built-in
    • Rate Limiting on auth endpoints
    • Secure Cookies with httpOnly flag
    • GDPR Compliance with data deletion

    Need help with authentication? Check our Getting Started guide.

    Authentication API

    The Ring Platform uses Auth.js v5 for comprehensive authentication with multiple providers including OAuth, magic links, and crypto wallets.

    Overview

    3 endpoints for authentication management:

    • User authentication and session management
    • Multi-provider OAuth integration
    • Crypto wallet authentication

    Authentication Flow

    Supported Providers

    OAuth Providers

    • Google - Primary OAuth provider
    • Apple - iOS/macOS integration
    • MetaMask - Crypto wallet authentication

    Magic Links

    • Email-based - Passwordless authentication
    • Secure tokens - Time-limited access
    • GDPR compliant - Privacy-first approach

    API Endpoints

    POST /api/auth/signin

    Initiate authentication with specified provider

    POST /api/auth/signout

    Sign out user and invalidate session

    GET /api/auth/session

    Get current user session information

    Implementation Examples

    Server-Side Authentication

    Client-Side Authentication

    Role-Based Access Control

    Role Hierarchy

    Ring Platform uses a hierarchical role system:

    1. VISITOR - Public access only
    2. SUBSCRIBER - Basic platform access
    3. MEMBER - Full platform features
    4. CONFIDENTIAL - Access to confidential entities
    5. ADMIN - Platform administration

    Security Features

    • Auth.js sessions — JWT strategy server-side; browser receives httpOnly session cookie
    • CSRF Protection built-in
    • Rate Limiting on auth endpoints
    • Secure Cookies with httpOnly flag
    • GDPR Compliance with data deletion

    Need help with authentication? Check our Getting Started guide.

    Authentication API

    The Ring Platform uses Auth.js v5 for comprehensive authentication with multiple providers including OAuth, magic links, and crypto wallets.

    Overview

    3 endpoints for authentication management:

    • User authentication and session management
    • Multi-provider OAuth integration
    • Crypto wallet authentication

    Authentication Flow

    Supported Providers

    OAuth Providers

    • Google - Primary OAuth provider
    • Apple - iOS/macOS integration
    • MetaMask - Crypto wallet authentication

    Magic Links

    • Email-based - Passwordless authentication
    • Secure tokens - Time-limited access
    • GDPR compliant - Privacy-first approach

    API Endpoints

    POST /api/auth/signin

    Initiate authentication with specified provider

    POST /api/auth/signout

    Sign out user and invalidate session

    GET /api/auth/session

    Get current user session information

    Implementation Examples

    Server-Side Authentication

    Client-Side Authentication

    Role-Based Access Control

    Role Hierarchy

    Ring Platform uses a hierarchical role system:

    1. VISITOR - Public access only
    2. SUBSCRIBER - Basic platform access
    3. MEMBER - Full platform features
    4. CONFIDENTIAL - Access to confidential entities
    5. ADMIN - Platform administration

    Security Features

    • Auth.js sessions — JWT strategy server-side; browser receives httpOnly session cookie
    • CSRF Protection built-in
    • Rate Limiting on auth endpoints
    • Secure Cookies with httpOnly flag
    • GDPR Compliance with data deletion

    Need help with authentication? Check our Getting Started guide.