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 ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-neon |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | Cloud connection holding the Neon credential |
neon_project_id | string | Yes | — | Neon project ID |
neon_branch_id | string | Yes | — | Neon branch ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | — |
neon_project_id | string | No | — | — |
neon_branch_id | string | No | — | — |
auth_base_url | string | No | — | — |
jwks_url | string | No | — | — |
auth_provider | string | No | — | — |
db_name | string | No | — | — |
provider_metadata | json | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
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"
}
}