Add JWKS URL

post

https://console.neon.tech/api/v2/projects/{project_id}/jwks

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.

Path Params

project_id

string

required

^[a-z0-9-]{1,60}$

The Neon project ID

Body Params

Add a new JWKS to a specific endpoint of a project

jwks_url

string

required

The URL that lists the JWKS

provider_name

string

required

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

branch_id

string

^[a-z0-9-]{1,60}$

Branch ID

jwt_audience

string

The name of the required JWT Audience to be used

role_names

array of strings

length between 0 and 10

deprecated

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.

role_names

skip_role_creation

boolean

Defaults to false

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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