v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Project

Add JWKS URL

Adds a JWKS URL to the specified project for verifying JWTs used as the authentication mechanism.

The URL must be a valid HTTPS URL that returns a JSON Web Key Set.

The provider_name field allows you to specify which authentication provider you're using (e.g., Clerk, Auth0, AWS Cognito).

The branch_id scopes the JWKS URL to specific branches; if not specified, it applies to all branches.

The role_names scopes the URL to specific roles; if not specified, default roles are used (authenticator, authenticated, anonymous).

The jwt_audience specifies which aud values are accepted in JWTs.

post/projects/{project_id}/jwks

Request body

jwks_urlstring required

The URL that lists the JWKS

provider_namestring required

The name of the authentication provider (e.g., Clerk, Stytch, Auth0)

branch_idstring

Branch ID

jwt_audiencestring

The name of the required JWT Audience to be used

role_namesstring[]

DEPRECATED. This field should only be used when using Neon RLS. The roles the JWKS should be mapped to. By default, the JWKS is mapped to the authenticator, authenticated and anonymous roles.

skip_role_creationboolean

DEPRECATED. This field should only be used when using Neon RLS. If true, the role creation will be skipped.

Response

The JWKS URL was added to the project's authentication connections

Example response

{
  "operations": [
    {
      "id": "d8ac46eb-a757-42b1-9907-f78322ee394e",
      "project_id": "spring-example-302709",
      "branch_id": "br-wispy-meadow-118737",
      "endpoint_id": "ep-silent-smoke-806639",
      "action": "start_compute",
      "status": "finished",
      "failures_count": 0,
      "created_at": "2022-11-15T20:02:00Z",
      "updated_at": "2022-11-15T20:02:02Z",
      "total_duration_ms": 200
    }
  ]
}