Aller au contenu

Overview

REST API for authentication, 2FA, password management, and SAML SSO.

Authentication

Protected endpoints require a JWT access token:

Authorization: Bearer <access_token>

Rate Limiting

Requests are rate limited. See individual endpoint descriptions for limits.

Note: recent portal features (WebAuthn, profile/avatar, company management, invitations, privacy, admin) are not yet specified here — see routes/api.php. Sync pending.

Information

  • OpenAPI version: 3.1.0

Security scheme type: http

Bearer format: JWT

Portal session cookie (Laravel session driver), accepted alongside bearerAuth by routes using the OidcBearerOrSession middleware. Session auth also requires the CSRF header (X-CSRF-TOKEN / XSRF-TOKEN) on state-changing requests.

Security scheme type: apiKey

Cookie parameter name: laravel_session

Pre-shared service-to-service API key (SANDBOX_MANAGER_SERVICE_KEY env var)

Security scheme type: http