Specification
This project publishes a Swagger 2.0 and OpenAPI 3 specification. You can find these files in
the GitHub project in the
swagger.yaml and
openapi.yaml files.
Hosted Swagger UI
The specification can also be viewed using the Swagger UI instance at swaggerui.magiclinks.dev.
Self-hosted specification
If you prefer to host the specification yourself, here are some projects that may help:
If you are implementing your own client, please note the default JWK Set relative path is /api/v1/jwks.json.
Every API client needs to validate the aud claim in the JWT. This is essential to prevent a malicious service
account from requesting a signed JWT for a different service. Every service account has at least one aud
given on creation. The iss claims should be checked too. The iss claim is specific to the configuration of the
magiclinksdev service, typically the URL.