Documentation Portal

Complete guides, API reference, and best practices for IdentityFirst platform

12 Modules REST API Integration Guides

Quick Start

Get up and running with IdentityFirst in minutes

1. Install Platform

# Windows installer
Invoke-WebRequest -Uri https://identityfirst.net/downloads/identityhealthcheck.msi -OutFile IdentityHealthCheck.msi
msiexec /i IdentityHealthCheck.msi /quiet

2. Get API Key

# Generate API key
curl -X POST \
  http://localhost:8001/auth/token

3. Make First Call

# Check health
curl http://localhost:8001/health

API Reference

Interactive API Documentation

IdentityFirst provides OpenAPI-compliant REST APIs with interactive Swagger documentation. Test endpoints directly from your browser.

Open Swagger UI Open ReDoc

Available Endpoints

# Core Platform
GET /health # Platform health check
GET /api/modules # List all modules

# FlowGuard - MFA Defense
GET /api/flowguard/alerts # Get MFA alerts
POST /api/flowguard/detect # Trigger detection

# Fortress - Identity Recovery
GET /api/fortress/snapshots # List snapshots
POST /api/fortress/compare # Compare snapshots

# SentienceX - Behavioral Analytics
GET /api/sentiencex/anomalies # Get anomalies
POST /api/sentiencex/analyze # Analyze behavior

# Fidara AI - AI Orchestration
POST /api/fidara/analyze # AI analysis
GET /api/fidara/personas # List personas

# Full API documentation at /docs

Module Guides

FlowGuard Guide

Setup MFA fatigue detection and configure alert policies

Coming Soon

Fortress Guide

Configure identity recovery and snapshot management

Coming Soon

SentienceX Guide

Setup behavioral analytics and anomaly detection

Coming Soon

LedgerX Guide

Track licenses and optimize software spending

Coming Soon

TactitionX Guide

Create and execute SOAR playbooks

Coming Soon

Fidara AI Guide

Leverage AI for security analysis and recommendations

Coming Soon

Module guides will be published with MVP launch (January 2026)

Integration Guides

Platform Connectors

Connect IdentityFirst to your existing identity infrastructure

Cloud Providers

  • Active Directory (On-Premises)
  • Azure AD / Microsoft Entra
  • AWS IAM Identity Center
  • Google Cloud Identity
  • Okta

Security Tools

  • Duo Security (MFA)
  • Splunk SIEM
  • Elastic Security
  • ServiceNow (Ticketing)
  • PagerDuty (Alerting)

Example: Azure AD Integration

# 1. Register app in Azure AD
az ad app create --display-name "IdentityFirst Connector"

# 2. Grant permissions
az ad app permission add \
  --id $APP_ID \
  --api 00000003-0000-0000-c000-000000000000 \
  --api-permissions e1fe6dd8-ba31-4d61-89e7-88639da4683d=Role

# 3. Configure in IdentityFirst
curl -X POST http://localhost:8001/api/connectors/azure \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"tenant_id": "...", "client_id": "...", "client_secret": "..."}'

Architecture Overview

Understanding IdentityFirst platform architecture

Microservices Design

Each module runs as an independent FastAPI service, enabling:

  • Independent scaling: Scale individual modules based on demand
  • Fault isolation: Module failures don't cascade to others
  • Easy updates: Deploy updates without full platform downtime
  • Technology flexibility: Use best tool for each job

Data Flow

# Event-driven architecture
Identity Event → FlowGuard Detection → RiskQuant Scoring
  → Fidara AI Analysis → TactitionX Response
  → GovernX Audit Log

# WebSocket real-time alerts
ws://localhost:8001/ws/alerts

# REST API for queries
GET /api/{module}/status

Need Help?

Our team is here to support your implementation

Contact Support View API Docs

Documentation updated: November 2025 | MVP Launch: January 31, 2026