API Specification

This project publishes formatted API specification files in Swagger 2.0 and OpenAPI 3 formats.

Specification files

Find the formatted specification files in the open-source GitHub project:

swagger.yaml
openapi.yaml

Generate code

Code generation is only useful if there is no SDK already written in your programming language of choice. Please see the SDK page for the official Golang client.

Code generation projects include:

swagger-codegen
openapi-generator

Visualize the API

The official API specification website is: swaggerui.magiclinks.dev

If you are implementing your own client, please note the default JWK Set relative path is /api/v2/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.