Blog

Just Hatched! Frontegg’s Revamped Documentation UI

A Fresh Take on Fronteggʼs Documentation

Our guides and OpenAPI documentation were ready for an upgrade, and weʼve delivered. With Fronteggʼs numerous microservices, each generating its own OpenAPI spec, we rolled up our sleeves and got to work. Over the past few months, weʼve completely revamped our documentation UI, delivering well- organized and clearly structured guides to help you easily integrate and use Fronteggʼs extensive features and capabilities.

One of the key goals of this overhaul was implementing automated pipelines to ensure our documentation and published specs are always up-to-date, accurate, and easy to navigate.

Whatʼs New?

A Modern Documentation Platform

As the first step in this migration, we transitioned to a new documentation platform and embraced a “docs-as-code” approach. This shift enhances the synchronization between our public APIs and the documentation portal, enabling a more efficient workflow with improved flexibility and customization options. Additionally, you can now subscribe to our public OpenAPI repository releases to stay updated on newly added, deprecated, or removed endpoints.

Click on the image to see more of the docs in action

Enhanced API Categorization

Fronteggʼs APIs, accessible in various contexts with different authorization types, are now clearly categorized within each service for easier navigation:

  • Management Endpoints: Require an environment authorization token, which can be generated using your environmentʼs credentials.
  • Self-Service Endpoints: Operate in the userʼs context, utilizing a userʼs authorization token. These endpoints enable you to build custom UIs or integrate Fronteggʼs self-service capabilities directly into your application without relying on the self-service portal. Examples include creating user groups, configuring SSO connections, and more.

Improved Flexibility and Control

Our new platform introduces enhanced flexibility for managing contextual complexities, offering key features such as:

  • Selecting the region where your Frontegg account is hosted.
  • Choosing to send requests from either a management or user perspective.
  • Configuring unique authorization tokens for different requests.
  • Monitoring request history for greater visibility and control.

These enhancements deliver a streamlined and customizable experience, empowering you to efficiently interact with Fronteggʼs APIs and build robust Customer Identity and Access Management (CIAM) and advanced authorization solutions for your application.

Click to see the docs in action

Whatʼs Coming

As we step into 2025, our dedication to enhancing the developer experience continues to grow. You can look forward to more comprehensive examples, clearer descriptions, and detailed request schemas to make your development journey smoother.

Have feedback or spotted an issue? Let us know! Use the helpfulness rating on any page and share your suggestions—your input is invaluable in helping us refine and improve our documentation.