Skip to content

API Documentation

This section provides access to the OpenAPI specifications for all AnkaSecure platform services.

OpenAPI Specifications

The following OpenAPI 3.0.0 specifications are available for each service:

Service Specification Description
Core API core.json Post-Quantum Cryptography operations, key management, streaming, and migration endpoints
Auth API auth.json Authentication endpoints for users and applications
PQC Handshake pqc.json Post-Quantum key exchange handshake endpoints

Specification Details

Core API (core.json)

  • Version: 3.0.0
  • Base Path: /api/v3
  • Key Controllers:
    • CryptoApiController - Encryption, decryption, signing, verification
    • CryptoStreamingApiController - Streaming crypto operations
    • Key management controllers - Key creation, query, lifecycle and algorithm catalogue
    • MigrationController - PKCS#7 analysis and conversion to JOSE
    • LicenseMetricsController - License validation metrics

Admin API — not published here

There is deliberately no vendored Admin API specification on this page.

For key management by automation, the supported integration path is the Key Management SDK, which is generated from the curated specification ankasecure-admin-api emits for it.

Auth API (auth.json)

  • Version: 3.0.0
  • Base Path: /api/v3/auth
  • Key Endpoints:
    • POST /authorize-challenge - The interactive sign-in transaction, ending in an authorization code
    • POST /token - OAuth 2.0 token endpoint (authorization_code with PKCE, client_credentials, refresh_token and RFC 8693 token-exchange; no password grant)
    • GET /api/v3/auth/account/memberships - List the tenants the signed-in identity may switch to
    • POST /token/introspect - Token introspection (RFC 7662)
    • POST /token/revoke - Token revocation (RFC 7009)
    • POST /token/logout - Logout and clear the refresh-token cookie
    • POST /account/password/forgot - Request a password-reset link
    • POST /account/password/reset - Complete a password reset
    • /account/authenticators, /account/recovery-codes, DELETE /account/password - Security self-service (passkeys, authenticator app, recovery codes, password removal)

PQC Handshake (pqc.json)

  • Version: 3.0.0
  • Base Path: /api/v3/pqc-handshake
  • Key Endpoints:
    • POST /init - Initialize the post-quantum key exchange
    • GET /supported-algorithms - List the KEM algorithms available on this deployment

Live Documentation

For interactive API exploration:

Usage Notes

  1. Import into Postman: Download the JSON files and import them into Postman for testing
  2. Code Generation: Use OpenAPI Generator to create client SDKs in your preferred language
  3. Validation: All specifications follow OpenAPI 3.0.0 standard and include RFC 7807 Problem Details for errors