Retrieve Neon Auth details for the branch

Retrieves the Neon Auth integration details for the specified branch,

GET /projects/{project_id}/branches/{branch_id}/authbeta

Retrieves the Neon Auth integration details for the specified branch, including the auth provider type and integration status.

Markdown for AI context

REST API - curl

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth" \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

Bash

neon neon-auth status

Tool: get_neon_auth_config

Read full Neon Auth configuration for a branch. Do not use when you need to update config (use configure_neon_auth instead). Requires Neon Auth to be provisioned first (use provision_neon_auth). Returns Neon Auth (Better Auth) for a branch as one JSON object: integration metadata (base_url, jwks_url, db_name, auth_provider, branch_id, created_at, owned_by, transfer_status, auth_provider_project_id), branch_name from the Neon branch API, project_id and resolved branch_id, plus the same configurable fields as configure_neon_auth (trusted_origins, allow_localhost, auth_methods.email_password with enabled, allow_sign_up, verify_email_on_sign_up, verify_email_on_sign_in, email_verification_method, require_email_verification, auto_sign_in_after_verification, oauth_providers (id, type, client_id, client_secret), email_provider (discriminated by type)). Top-level base_url, jwks_url, and db_name duplicate integration for quick copy. Optional _errors records partial fetch failures for configurable slices. Secrets — OAuth client_secret and the SMTP password — are NEVER returned. When the upstream config indicates a secret is set, this endpoint surfaces it as the literal sentinel "redacted"; when no secret is set the field is null. Use the matching configure_neon_auth operations to write or rotate these values.

projectId (string, required) Neon project ID
branchId (string, optional) Branch ID. If omitted, the project default branch is used (same as provision_neon_auth).

Console path: Projects → Auth → Configuration

Parameters

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

Response

200

Fetched the details of the Neon Auth integration for the specified branch

Depth

"auth_provider": (string),reqmock | stack | better_auth

"auth_provider_project_id": (string),req

"branch_id": (string),req

"db_name": (string),req

"created_at": (string),reqdate-time

"owned_by": (string),requser | neon

"jwks_url": (string),req

"base_url": (string),

"name": (string),≥1 chars, ≤256 chars

"transfer_status": (string),initiated | finished

Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

message Required. Human-readable error message.
code Required. Machine-readable error code.
request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.