Auth

Retrieve Neon Auth details for the branch

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

get/projects/{project_id}/branches/{branch_id}/auth

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

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

auth_provider'mock' | 'stack' | 'better_auth' required
auth_provider_project_idstring required
branch_idstring required
db_namestring required
created_atstring date-time required
owned_by'user' | 'neon' required
transfer_status'initiated' | 'finished'
jwks_urlstring required
base_urlstring
namestring

The application name used in auth emails and communications. Defaults to the Neon project name.

Changes

No recorded changes to this operation across all 1 revision of this API.