Skip to content
Proud to collaborate with Microsoft for Startups

neon.role.reset_password ​

Reset a Neon role's password (does not return a connection URI or password)

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidNo—Local NeonBranch handle (tracked path). Supply this OR neon_project_id+neon_branch_id (provider path).
neon_project_idstringNo—Neon provider project id (provider path — reaches provider-created branches with no local row)
neon_branch_idstringNo—Neon provider branch id (provider path)
role_namestringYes——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidNo—Local NeonBranch handle (tracked path). Supply this OR neon_project_id+neon_branch_id (provider path).
neon_project_idstringNo—Neon provider project id (provider path — reaches provider-created branches with no local row)
neon_branch_idstringNo—Neon provider branch id (provider path)
role_namestringYes——
actorstringNo——
credentialstringNo—Ephemeral plaintext role credential — never persisted, scrubbed pre-COMPLETED
reset_atstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—resetInputs accepted
resettingNoNo—completeResetting the role password at Neon
completedNoYesYes—Password reset
failedNoYesNo—Reset failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedresetresetting—
resettingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "neon.role.reset_password",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "role_name": "value"
  }
}