Add JWKS URL

Add a new JWKS URL to a project, such that it can be used for verifying JWTs used as the authentication mechanism for the specified project.

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, etc.).

The branch_id can be used to specify on which branches the JWKS URL will be accepted. If not specified, then it will work on any branch.

The role_names can be used to specify for which roles the JWKS URL will be accepted. If not specified, then default roles will be used (authenticator, authenticated and anonymous).

The jwt_audience can be used to specify which "aud" values should be accepted by Neon in the JWTs that are used for authentication.

Path Params
string
required

The Neon project ID

Body Params

Add a new JWKS to a specific endpoint of a project

string
required

The URL that lists the JWKS

string
required

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

string

Branch ID

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
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json