API ReferenceOpenAPI Specification

OpenAPI Specification

The Descope REST API is fully documented as an OpenAPI 3.0 specification. You can download it and import it into Postman, use it to generate API clients in any language, or browse it with your favorite OpenAPI viewer.

Download Descope_API.yaml

What's included

  • Every Descope public API endpoint with full request/response schemas
  • Authentication endpoints (OTP, Magic Link, Enchanted Link, OAuth, SAML, WebAuthn, TOTP, NOTP, Passwords)
  • Management endpoints (users, tenants, roles, permissions, SSO apps, third-party apps, FGA, flows, etc.)
  • Session endpoints (refresh, validate, get keys)
  • Federated app endpoints (OIDC, SAML IDP, WS-Fed IDP)

Using the spec

Postman

  1. Open Postman → Import → File
  2. Select the downloaded Descope_API.yaml
  3. Postman will create a collection with all endpoints organized by tag

Generating clients

Use any OpenAPI client generator (e.g. openapi-generator, swagger-codegen) with the downloaded spec to scaffold a client in your preferred language.

Online viewers

Drop the spec into any OpenAPI viewer (Swagger Editor, Redocly, Stoplight) to browse it interactively.

Was this helpful?

REST API Reference

Use the Descope REST API to build authentication and user management for your app while retaining full control over your UI.

OTP Authentication API Overview

Use the Descope REST API to build one-time password (OTP) authentication for your application.

On this page

OpenAPI SpecificationWhat's includedUsing the specPostmanGenerating clientsOnline viewers