Skip to content
Proud to collaborate with Microsoft for Startups

neon.auth.get ​

Fetch Neon Managed Auth (Better Auth) configuration for a branch

Fetch Managed Better Auth (Neon Auth) configuration for a branch.

Issues GET /projects/{neon_project_id}/branches/{neon_branch_id}/auth.

Inputs:

  • connection_uuid: Neon cloud connection (required).
  • neon_project_id: Neon project ID (required).
  • neon_branch_id: Neon branch ID (required).

Outputs (terminal state_data):

  • auth_base_url: str — Neon Auth base URL (…/auth)
  • jwks_url: str — JWKS URL for Data API JWT verification
  • auth_provider: str — e.g. better_auth
  • db_name: str — database Neon Auth is bound to
  • provider_metadata: dict — full Neon response body

Error policy:

  • HTTP 404 → WorkflowNotRetryableError (Auth not enabled on branch).
  • other 4xx → WorkflowNotRetryableError.
  • 5xx / timeouts → propagate so the engine retries.

Plugin required: context.get_plugin("neon") must expose .api_token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—Cloud connection holding the Neon credential
neon_project_idstringYes—Neon project ID
neon_branch_idstringYes—Neon branch ID

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
neon_project_idstringNo——
neon_branch_idstringNo——
auth_base_urlstringNo——
jwks_urlstringNo——
auth_providerstringNo——
db_namestringNo——
provider_metadatajsonNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "neon.auth.get",
  "initial_data": {
    "connection_uuid": "value",
    "neon_project_id": "value",
    "neon_branch_id": "value"
  }
}