Dynamic JWKS API

Fetch the JSON Web Key Set used to verify Dynamic JWTs.

OpenAPI Specification

dynamic-labs-jwks-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Dynamic Allowlists JWKS API
  description: Representative OpenAPI description of the Dynamic environment-scoped REST API for web3 authentication and embedded wallets. Admin endpoints authenticate with an environment-scoped bearer API token (dyn_ prefixed); SDK endpoints authenticate with a user JWT obtained via the client SDK. This document is a faithful, non-exhaustive representation of publicly documented surfaces at https://docs.dynamic.xyz/api-reference. Consult the live API reference for the complete schema catalog.
  termsOfService: https://www.dynamic.xyz/terms
  contact:
    name: Dynamic Support
    url: https://www.dynamic.xyz/contact
  version: v0
servers:
- url: https://app.dynamicauth.com/api/v0
  description: Production
- url: https://app.dynamic.xyz/api/v0
  description: Production (alternate host)
security:
- bearerAuth: []
tags:
- name: JWKS
  description: Fetch the JSON Web Key Set used to verify Dynamic JWTs.
paths:
  /sdk/{environmentId}/.well-known/jwks.json:
    get:
      operationId: getJwks
      tags:
      - JWKS
      summary: Find JWKS for public key (JSON format).
      description: Returns the JSON Web Key Set (JWKS) for the environment, used to verify the signature of Dynamic-issued JWT auth tokens server-side. This endpoint does not require authentication.
      security: []
      parameters:
      - $ref: '#/components/parameters/EnvironmentId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Jwks'
components:
  parameters:
    EnvironmentId:
      name: environmentId
      in: path
      required: true
      description: The ID of the Dynamic environment (project).
      schema:
        type: string
        format: uuid
  schemas:
    Jwks:
      type: object
      properties:
        keys:
          type: array
          items:
            type: object
            properties:
              kty:
                type: string
              use:
                type: string
              kid:
                type: string
              alg:
                type: string
              n:
                type: string
              e:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: dyn_token
      description: 'Environment-scoped API token with a dyn_ prefix for admin endpoints, or a user JWT from the client SDK for SDK endpoints. Sent as Authorization: Bearer <token>.'