Descope API Documentation

This repository contains the source for the Descope API Documentation, built with Fern.

Project Structure

fern/
├── docs.yml                  # Site configuration (navigation, tabs, colors, navbar)
├── fern.config.json          # Fern project config (organization, version)
├── generators.yml            # API spec source configuration
├── openapi/
│   └── openapi.yaml          # Descope OpenAPI 3.0 specification
└── pages/                    # Documentation content (MDX)
    ├── welcome.mdx
    ├── authentication.mdx
    ├── getting-started/      # Quickstarts & framework guides
    ├── auth-methods/         # OTP, Magic Link, Passkeys, OAuth, SSO, etc.
    ├── authorization/        # RBAC, ReBAC, ABAC, sessions
    ├── flows/                # Visual flow builder docs
    ├── widgets/              # UI widget docs
    ├── sdks/                 # Client, Mobile, Backend SDK docs
    ├── agentic-identity-hub/ # MCP & agentic identity
    ├── identity-federation/  # Applications & federation
    ├── connectors/           # Connector integrations
    ├── management/           # Users, tenants, access keys, settings
    ├── guides/               # B2B, SSO tutorials, fingerprinting
    ├── migration/            # Migration guides
    ├── deployment/           # Production deployment & test users
    └── troubleshooting/      # Common errors

Prerequisites

• Node.js (v18+)
• Fern CLI

Install the Fern CLI globally:

npm install -g fern-api

Getting Started

1. Install dependencies

fern install

2. Validate the configuration

Check that the docs config and OpenAPI spec are valid:

fern check

3. Preview locally

Run a local development server to preview the docs:

fern docs dev

4. Generate the docs

To trigger a full docs build and publish:

fern generate --docs

The site will be deployed to https://descope.docs.buildwithfern.com.

Editing Content

Adding or editing a page

1. Create or edit an .mdx file under fern/pages/.
2. Register the page in fern/docs.yml under the appropriate section in the navigation tree.

Updating the API reference

The API reference is auto-generated from fern/openapi/openapi.yaml. To update it, modify the OpenAPI spec and run fern check to validate.

Configuration reference

File	Purpose
fern/docs.yml	Site title, tabs, navigation, navbar links, colors
fern/fern.config.json	Fern organization name and CLI version
fern/generators.yml	Points Fern to the OpenAPI spec

Key Links

• Live docs: https://descope.docs.buildwithfern.com
• Descope Console: https://app.descope.com
• Descope website: https://descope.com
• Fern documentation: https://docs.buildwithfern.com