Update Journey
updateJourneyModify an existing authentication journey by updating metadata fields or replacing the node graph; unspecified fields are preserved.
Instructions
Update an existing authentication journey. Fetches the current journey, merges any caller-provided metadata fields (description, identityResource, mustRun, innerTreeOnly, uiConfig, enabled, maximumSessionTime, maximumIdleTime), and PUTs the result back. If nodes and/or entryNodeId are provided, the graph is replaced atomically using the same UUID transformation pipeline as createJourney; otherwise the existing graph is preserved unchanged. Fields not supplied by the caller are preserved from the fetched journey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| realm | Yes | The realm containing the journey | |
| journeyName | Yes | The name of the journey to update | |
| description | No | Admin-facing description of the journey | |
| identityResource | No | The identity resource that the journey authenticates against. Expected format: "managed/<realm>_<objectType>" (e.g., "managed/alpha_user", "managed/bravo_role"). | |
| mustRun | No | Whether the journey must run to completion | |
| innerTreeOnly | No | Whether the journey can only be used as an inner tree | |
| uiConfig | No | Unbounded JSON object of UI configuration key/value pairs. The set of meaningful keys is defined by AM and is not enumerated here. To discover the shape for a given journey, read it first with getJourney. | |
| enabled | No | Whether the journey is enabled | |
| maximumSessionTime | No | Maximum session time in minutes | |
| maximumIdleTime | No | Maximum idle time in minutes | |
| entryNodeId | No | ID of the first node (connected from Start). Required when replacing the graph. Can be human-readable; will be transformed to UUID. | |
| nodes | No | Map of node IDs to node definitions. When provided, replaces the existing graph entirely and must be provided together with entryNodeId. Keys can be human-readable (e.g., "login-page"); they will be transformed to UUIDs. |