Singularity API
Welcome to the Singularity!
This documentation covers the ready-to-use endpoints for authentication, user management, and content management that come pre-configured with Singularity.
Features at a Glance:
-
Authentication & User Management: Includes JWT auth with refresh tokens, 2FA, email verification, and role-based access control.
-
Data & Content Management: Endpoints for interacting with a content management system that supports multi-language content, configurable tagging, and built-in access control. A prebuilt
Articleclass is also provided. -
Performance & Security: The API is built with a focus on production-readiness, including rate limiting and secret manager integration with automated key rotation.
This API is a foundation for building robust backend services, microservices, or full-stack applications.
Note: Some endpoints require explicit configuration to be enabled.
Authentication
- API Key: twoFactorAuthenticationTokenCookie
- HTTP: Bearer Auth
- API Key: accessTokenCookie
- API Key: stepUpTokenCookie
- API Key: twoFactorAuthenticationTokenHeader
- HTTP: Bearer Auth
- API Key: stepUpTokenHeader
- API Key: refreshTokenCookie
EmailVerificationTokenCreation for successful authentication with email and password, indicating 2FA is required.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Cookie parameter name: | two_factor_authentication_token |
Access token for user authentication. You can learn more here.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Access token for user authentication.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Cookie parameter name: | access_token |
EmailVerificationTokenCreation for step up authentication allowing access of secure resources.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Cookie parameter name: | step_up_token |
EmailVerificationTokenCreation for successful authentication with email and password, indicating 2FA is required.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Two-Factor-Authentication-EmailVerificationTokenCreation |
Refresh token to request new access tokens.You can learn more here.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
EmailVerificationTokenCreation for step up authentication allowing access of secure resources.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Step-Up-EmailVerificationTokenCreation |
Refresh token to request new access tokens.You can learn more here.
Security Scheme Type: | apiKey |
|---|---|
Cookie parameter name: | refresh_token |
License
GPLv3 License