Skip to content
Proud to collaborate with Microsoft for Startups

neon.role.create ​

Create a Neon role on a branch and persist the local row

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidYes——
role_namestringYes——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidYes——
role_namestringYes——
actorstringNo——
neon_project_idstringNo——
neon_branch_idstringNo——
neon_role_uuiduuidNo——
provider_metadatajsonNo——
created_atstringNo——
persisted_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—createInputs accepted
creatingNoNo—persistCreating role at Neon
persistingNoNo—completePersisting NeonRole row
completedNoYesYes—Role created
failedNoYesNo—Create failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedcreatecreating—
creatingpersistpersisting—
persistingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

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