Skip to main content

API Documentation Sources

This document lists all the API sources used to generate and maintain the AuthSec API documentation.

Live API Documentation​

User Flow API (User Management)​

Documented Sections:

  • User Management (Admin Users, End Users)
  • Authentication flows
  • MFA Authentication
  • Directory Synchronization
  • User invitations

Corresponding Docs: /docs/user-management/

Auth Manager API​

Documented Sections:

  • Token Management (JWT generation)
  • Token Validation
  • Group Management
  • User Profile
  • Debug endpoints
  • Health checks

Corresponding Docs: /docs/auth-manager/

WebAuthn Service API​

Documented Sections:

  • WebAuthn registration and authentication (Admin and End User flows)
  • TOTP setup and verification
  • SMS verification

Corresponding Docs: /docs/webauthn-mfa/

Client Management API​

Documented Sections:

  • Client CRUD operations
  • Client status management (activate/deactivate)
  • Client filtering and pagination

Corresponding Docs: /docs/client-management/

External Service API​

Documented Sections:

  • Service lifecycle management (CRUD operations)
  • Service credential retrieval
  • Authentication debugging utilities

Corresponding Docs: /docs/external-service/

Endpoint to Documentation Mapping​

User Flow API Endpoints​

Endpoint PatternDocumentation File
/uflow/admin/users/*admin-users.md
/uflow/users/*end-users.md
/uflow/admin/auth/*, /uflow/auth/*authentication.md
/uflow/admin/totp/*, /uflow/admin/webauthn/*, /uflow/admin/ciba/*mfa-authentication.md
/uflow/admin/activedirectory/*, /uflow/admin/entra-id/*directory-sync.md
/uflow/admin/invitations/*invitations.md

Auth Manager Endpoints​

Endpoint PatternDocumentation File
/authmgr/auth/*/generateTokentoken-management.md
/authmgr/auth/*/oidcTokentoken-management.md
/authmgr/auth/admin/group/*groups.md
/authmgr/validate/*validation.md
/authmgr/auth/*/profileprofile.md
/authmgr/auth/*/debug/*debug.md
/authmgr/auth/*/healthsystem.md

WebAuthn Service Endpoints​

Endpoint PatternDocumentation File
/webauthn/admin/*webauthn.md
/webauthn/enduser/*webauthn.md
/webauthn/totp/*totp.md
/webauthn/sms/*sms.md

Client Management Endpoints​

Endpoint PatternDocumentation File
/clientms/clients/v1/tenants/{tenantId}/clientsclients.md
/clientms/clients/v1/tenants/{tenantId}/clients/{id}clients.md
/clientms/clients/v1/*/clients/*/activateclient-status.md
/clientms/clients/v1/*/clients/*/deactivateclient-status.md

External Service Endpoints​

Endpoint PatternDocumentation File
/api/v1/servicesservices.md
/api/v1/services/{id}services.md
/api/v1/services/{id}/credentialscredentials.md
/debug/authdebug.md

Update Process​

Manual Update Workflow​

  1. Fetch Latest Specs

    # User Flow API
    curl https://dev.api.authsec.dev/uflow/redoc > uflow-spec.html

    # Auth Manager
    curl https://dev.api.authsec.dev/authmgr/swagger.json > authmgr-spec.json

    # WebAuthn Service
    curl https://dev.api.authsec.dev/webauthn/swagger.json > webauthn-spec.json

    # Client Management
    curl https://dev.api.authsec.dev/clientms/swagger/doc.json > clientms-spec.json

  2. Parse API Specifications

    • Extract endpoint paths, methods, and descriptions
    • Identify request/response schemas
    • Note authentication requirements
    • Document parameter types

  3. Update Documentation Files

    • Match endpoints to appropriate documentation files (see mapping above)
    • Update endpoint descriptions
    • Add/remove endpoints as needed
    • Update request/response examples
    • Verify all links remain valid

  4. Test Changes

    # Clear cache and rebuild
    rm -rf .docusaurus node_modules/.cache
    npm start

AI Agent Update Protocol​

For automated updates by AI agents, follow the README.md instructions which include:

  • Detailed endpoint-to-file mapping
  • Markdown structure preservation guidelines
  • Code sample formatting requirements
  • Consistency checks

Additional Documentation Sources​

RBAC & Authorization​

Advanced Authentication​

System & Infrastructure​

  • Source: Health check endpoints and tenant management
  • Docs: /docs/system/

Version History​

DateAPIVersionChanges
2026-01-20User Flow API4.0.0Initial documentation
2026-01-20Auth Manager1.1.0Initial documentation
2026-01-20WebAuthn Service2.0Initial documentation
2026-01-20Client Management0.4.0Initial documentation
2026-02-11External Service1.0Initial documentation
2026-02-11Documentation-Reorganized to user journey structure
2026-02-11Documentation-Added MagicUI progressive blur effects

Missing Sources​

Currently, all known APIs are documented. If additional microservices are discovered, they will be listed here.

Future Services​

  • Add any newly discovered microservices here

Contact & Support​

For questions about API sources or to report outdated documentation:

  • Review Swagger/ReDoc interfaces for the latest endpoint information
  • Check version numbers in the live documentation
  • Compare with this sources list to identify discrepancies

Last Updated: 2026-02-11
Maintained By: Documentation Team