Create Auth Provider SDK keys

POST/projects/auth/keysCreate Auth Provider SDK keys

Generates SDK or API Keys for the auth provider. These might be called different things depending on the auth provider you're using, but are generally used for setting up the frontend and backend SDKs.

Request body

required

application/json

objectNeonAuthCreateAuthProviderSDKKeysRequest

auth_providerstringrequired

Authentication provider integrated with this Neon Auth configuration. `better_auth` integrates with Better Auth (the current, recommended provider). `stack` integrates with Stack Auth (deprecated). `mock` is a simulated provider for local development and testing only.

one of "mock", "stack", "better_auth"

project_idstringrequired

The Neon project ID. Returned as `id` from `GET /projects`.

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

Example request

{
  "auth_provider": "better_auth",
  "project_id": "wispy-forest-12345678"
}

Responses

objectNeonAuthCreateIntegrationResponse

auth_providerstringrequired

one of "mock", "stack", "better_auth"

auth_provider_project_idstringrequired

Project ID assigned by the auth provider for this integration.

base_urlstring

Base URL of the Neon Auth service for this integration. Set as the NEON_AUTH_BASE_URL environment variable in your application.

jwks_urlstringrequired

URL of the provider's JWKS endpoint used to verify JWTs.

pub_client_keystringrequired

Publishable SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth.

schema_namestringrequired

Postgres schema containing the auth integration tables. Defaults to `neon_auth`.

secret_server_keystringrequired

Secret server-side SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth. Treat as a credential.

table_namestringrequired

Postgres table in the integration schema where synced user records are stored.

Example response

{
  "auth_provider": "better_auth",
  "auth_provider_project_id": "string",
  "base_url": "string",
  "jwks_url": "string",
  "pub_client_key": "string",
  "schema_name": "string",
  "secret_server_key": "string",
  "table_name": "string"
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

curl -X POST 'https://console.neon.tech/api/v2/projects/auth/keys' \
  -H 'Content-Type: application/json' \
  -d '{"auth_provider":"better_auth","project_id":"wispy-forest-12345678"}'

const response = await fetch('https://console.neon.tech/api/v2/projects/auth/keys', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"auth_provider":"better_auth","project_id":"wispy-forest-12345678"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/auth/keys', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"auth_provider\":\"better_auth\",\"project_id\":\"wispy-forest-12345678\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/projects/auth/keys",
    headers={"Content-Type": "application/json"},
    data='{"auth_provider":"better_auth","project_id":"wispy-forest-12345678"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"auth_provider":"better_auth","project_id":"wispy-forest-12345678"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/projects/auth/keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/auth/keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"auth_provider\":\"better_auth\",\"project_id\":\"wispy-forest-12345678\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/auth/keys"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"auth_provider\":\"better_auth\",\"project_id\":\"wispy-forest-12345678\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/auth/keys")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"auth_provider\":\"better_auth\",\"project_id\":\"wispy-forest-12345678\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://console.neon.tech/api/v2/projects/auth/keys");
request.Content = new StringContent("{\"auth_provider\":\"better_auth\",\"project_id\":\"wispy-forest-12345678\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "auth_provider": "better_auth",
  "auth_provider_project_id": "string",
  "base_url": "string",
  "jwks_url": "string",
  "pub_client_key": "string",
  "schema_name": "string",
  "secret_server_key": "string",
  "table_name": "string"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}