JSON Output for exports

[dieterdanger]

Hello everyone,
first of all thanks for this fantastic tool!

I'm in the process of automating our on premise AM deployment and I'm asking myself wether it is possible to output journey/scripts exports to json files? This would make handling in scripts a lot easier.

Right now I'm seeing options for simple output 'as is' or markdown for journeys.

Thanks and best regards
Dennis

[vscheuber]

Hi @dieterdanger , the default export format for all frodo exports is JSON. Could you run an export on one or all of your journeys and open the resulting JSON file and let me know if that meets your needs?

Here are a few sample commands to get different exports depending on your needs:

Export single journey and all its dependencies by name to a single file in ~/temp:

% frodo journey export -i Login -D ~/temp volker-dev
Connected to https://openam-volker-dev.forgeblocks.com/am [alpha] as service account Frodo-SA-1712175401543 [eb108b7a-e039-40bc-9764-84bed891fee1]
✔ Exported Login to /Users/vscheuber/temp/Login.journey.json.
%

Export all journeys and all their dependencies to a single file in ~/temp:

% frodo journey export -a -D ~/temp volker-dev
Connected to https://openam-volker-dev.forgeblocks.com/am [alpha] as service account Frodo-SA-1712175401543 [eb108b7a-e039-40bc-9764-84bed891fee1]
[========================================] 100% | 116/116 | Exported 116 journeys.
% ll ~/temp/allAlphaJourneys.journey.json 
-rw-r--r--  1 vscheuber  staff   2.0M Nov 13 09:22 /Users/vscheuber/temp/allAlphaJourneys.journey.json
%

Export all journeys and all their dependencies to individual files in ~/temp/journeys:

% frodo journey export -A -D ~/temp/journeys volker-dev
Connected to https://openam-volker-dev.forgeblocks.com/am [alpha] as service account Frodo-SA-1712175401543 [eb108b7a-e039-40bc-9764-84bed891fee1]
[========================================] 100% | 116/116 | Exported 116 journeys.
[========================================] 100% | 1/1 | AA saved to /Users/vscheuber/temp/journeys/AA.journey.json
[========================================] 100% | 1/1 | AccessRestrictions saved to /Users/vscheuber/temp/journeys/AccessRestrictions.journey.json
[========================================] 100% | 1/1 | ADFSOIDC saved to /Users/vscheuber/temp/journeys/ADFSOIDC.journey.json
[========================================] 100% | 1/1 | AgentLogin saved to /Users/vscheuber/temp/journeys/AgentLogin.journey.json
[========================================] 100% | 1/1 | Anonymous saved to /Users/vscheuber/temp/journeys/Anonymous.journey.json
[========================================] 100% | 1/1 | APIProtection saved to /Users/vscheuber/temp/journeys/APIProtection.journey.json
[========================================] 100% | 1/1 | Azure saved to /Users/vscheuber/temp/journeys/Azure.journey.json
[========================================] 100% | 1/1 | AzureADPassthru saved to /Users/vscheuber/temp/journeys/AzureADPassthru.journey.json
[========================================] 100% | 1/1 | AzureOIDC saved to /Users/vscheuber/temp/journeys/AzureOIDC.journey.json
[========================================] 100% | 1/1 | base saved to /Users/vscheuber/temp/journeys/base.journey.json
[========================================] 100% | 1/1 | brandoProtect saved to /Users/vscheuber/temp/journeys/brandoProtect.journey.json
[========================================] 100% | 1/1 | CD Test saved to /Users/vscheuber/temp/journeys/CD-Test.journey.json
[========================================] 100% | 1/1 | ClearLockout saved to /Users/vscheuber/temp/journeys/ClearLockout.journey.json
[========================================] 100% | 1/1 | CollectReplayCredentials saved to /Users/vscheuber/temp/journeys/CollectReplayCredentials.journey.json
[========================================] 100% | 1/1 | ConnectSocial saved to /Users/vscheuber/temp/journeys/ConnectSocial.journey.json
[========================================] 100% | 1/1 | CookieConsent saved to /Users/vscheuber/temp/journeys/CookieConsent.journey.json
[========================================] 100% | 1/1 | Country saved to /Users/vscheuber/temp/journeys/Country.journey.json
[========================================] 100% | 1/1 | CustomerIdentityUpdateUsername saved to /Users/vscheuber/temp/journeys/CustomerIdentityUpdateUsername.journey.json
[========================================] 100% | 1/1 | CustomHostedUILogin saved to /Users/vscheuber/temp/journeys/CustomHostedUILogin.journey.json
[========================================] 100% | 1/1 | DefaultSuccessURL saved to /Users/vscheuber/temp/journeys/DefaultSuccessURL.journey.json
[========================================] 100% | 1/1 | DelegatedProfileUpdate saved to /Users/vscheuber/temp/journeys/DelegatedProfileUpdate.journey.json
[========================================] 100% | 1/1 | DeviceBindingAndSigning saved to /Users/vscheuber/temp/journeys/DeviceBindingAndSigning.journey.json
[========================================] 100% | 1/1 | DevicePrint saved to /Users/vscheuber/temp/journeys/DevicePrint.journey.json
[========================================] 100% | 1/1 | Disabled saved to /Users/vscheuber/temp/journeys/Disabled.journey.json
[========================================] 100% | 1/1 | Dropdown saved to /Users/vscheuber/temp/journeys/Dropdown.journey.json
[========================================] 100% | 1/1 | DynamicConfiguration saved to /Users/vscheuber/temp/journeys/DynamicConfiguration.journey.json
[========================================] 100% | 1/1 | EmailValidation saved to /Users/vscheuber/temp/journeys/EmailValidation.journey.json
[========================================] 100% | 1/1 | FindUser saved to /Users/vscheuber/temp/journeys/FindUser.journey.json
[========================================] 100% | 1/1 | FindUserFromSession saved to /Users/vscheuber/temp/journeys/FindUserFromSession.journey.json
[========================================] 100% | 1/1 | ForgottenUsername saved to /Users/vscheuber/temp/journeys/ForgottenUsername.journey.json
[========================================] 100% | 1/1 | FRAAS-7955 saved to /Users/vscheuber/temp/journeys/FRAAS-7955.journey.json
[========================================] 100% | 1/1 | FraudRisk saved to /Users/vscheuber/temp/journeys/FraudRisk.journey.json
[========================================] 100% | 1/1 | Hash saved to /Users/vscheuber/temp/journeys/Hash.journey.json
[========================================] 100% | 1/1 | HelpdeskVerifyUser saved to /Users/vscheuber/temp/journeys/HelpdeskVerifyUser.journey.json
[========================================] 100% | 1/1 | IdentityProofing saved to /Users/vscheuber/temp/journeys/IdentityProofing.journey.json
[========================================] 100% | 1/1 | iExistingSession saved to /Users/vscheuber/temp/journeys/iExistingSession.journey.json
[========================================] 100% | 1/1 | iFraudRisk saved to /Users/vscheuber/temp/journeys/iFraudRisk.journey.json
[========================================] 100% | 1/1 | Impersonate saved to /Users/vscheuber/temp/journeys/Impersonate.journey.json
[========================================] 100% | 1/1 | Impersonation saved to /Users/vscheuber/temp/journeys/Impersonation.journey.json
[========================================] 100% | 1/1 | inner1 saved to /Users/vscheuber/temp/journeys/inner1.journey.json
[========================================] 100% | 1/1 | inner2 saved to /Users/vscheuber/temp/journeys/inner2.journey.json
[========================================] 100% | 1/1 | iNotifyUserHighRisk saved to /Users/vscheuber/temp/journeys/iNotifyUserHighRisk.journey.json
[========================================] 100% | 1/1 | iNotifyUserMediumRisk saved to /Users/vscheuber/temp/journeys/iNotifyUserMediumRisk.journey.json
[========================================] 100% | 1/1 | iP1P-LoginRisk saved to /Users/vscheuber/temp/journeys/iP1P-LoginRisk.journey.json
[========================================] 100% | 1/1 | iPasswordBreachDetection saved to /Users/vscheuber/temp/journeys/iPasswordBreachDetection.journey.json
[========================================] 100% | 1/1 | iSocialLogin saved to /Users/vscheuber/temp/journeys/iSocialLogin.journey.json
[========================================] 100% | 1/1 | iUsernamePasswordLogin saved to /Users/vscheuber/temp/journeys/iUsernamePasswordLogin.journey.json
[========================================] 100% | 1/1 | KerberosLogin saved to /Users/vscheuber/temp/journeys/KerberosLogin.journey.json
[========================================] 100% | 1/1 | LanguageSwitcher saved to /Users/vscheuber/temp/journeys/LanguageSwitcher.journey.json
[========================================] 100% | 1/1 | Launcher saved to /Users/vscheuber/temp/journeys/Launcher.journey.json
[========================================] 100% | 1/1 | Login saved to /Users/vscheuber/temp/journeys/Login.journey.json
[========================================] 100% | 1/1 | Metrics saved to /Users/vscheuber/temp/journeys/Metrics.journey.json
[========================================] 100% | 1/1 | MFAAutoSelect saved to /Users/vscheuber/temp/journeys/MFAAutoSelect.journey.json
[========================================] 100% | 1/1 | MFASplitter saved to /Users/vscheuber/temp/journeys/MFASplitter.journey.json
[========================================] 100% | 1/1 | MFAWithEmailLink saved to /Users/vscheuber/temp/journeys/MFAWithEmailLink.journey.json
[========================================] 100% | 1/1 | MFAWithEmailOTP saved to /Users/vscheuber/temp/journeys/MFAWithEmailOTP.journey.json
[========================================] 100% | 1/1 | MFAWithSMSOTP saved to /Users/vscheuber/temp/journeys/MFAWithSMSOTP.journey.json
[========================================] 100% | 1/1 | MFAWithVoiceOTP saved to /Users/vscheuber/temp/journeys/MFAWithVoiceOTP.journey.json
[========================================] 100% | 1/1 | MobileGenerateEmailOTP saved to /Users/vscheuber/temp/journeys/MobileGenerateEmailOTP.journey.json
[========================================] 100% | 1/1 | MobileValidateEmailOTP saved to /Users/vscheuber/temp/journeys/MobileValidateEmailOTP.journey.json
[========================================] 100% | 1/1 | NodeStateIssue saved to /Users/vscheuber/temp/journeys/NodeStateIssue.journey.json
[========================================] 100% | 1/1 | NodeStateIssue2 saved to /Users/vscheuber/temp/journeys/NodeStateIssue2.journey.json
[========================================] 100% | 1/1 | Oath saved to /Users/vscheuber/temp/journeys/Oath.journey.json
[========================================] 100% | 1/1 | OathJoker saved to /Users/vscheuber/temp/journeys/OathJoker.journey.json
[========================================] 100% | 1/1 | Okta_Passthru saved to /Users/vscheuber/temp/journeys/Okta_Passthru.journey.json
[========================================] 100% | 1/1 | Okta_SAML saved to /Users/vscheuber/temp/journeys/Okta_SAML.journey.json
[========================================] 100% | 1/1 | OpenAccount saved to /Users/vscheuber/temp/journeys/OpenAccount.journey.json
[========================================] 100% | 1/1 | OTPEndpoint saved to /Users/vscheuber/temp/journeys/OTPEndpoint.journey.json
[========================================] 100% | 1/1 | P1P saved to /Users/vscheuber/temp/journeys/P1P.journey.json
[========================================] 100% | 1/1 | P1P-Login saved to /Users/vscheuber/temp/journeys/P1P-Login.journey.json
[========================================] 100% | 1/1 | Passthru saved to /Users/vscheuber/temp/journeys/Passthru.journey.json
[========================================] 100% | 1/1 | PasswordBreachDetection saved to /Users/vscheuber/temp/journeys/PasswordBreachDetection.journey.json
[========================================] 100% | 1/1 | PasswordGrant saved to /Users/vscheuber/temp/journeys/PasswordGrant.journey.json
[========================================] 100% | 1/1 | PostBody saved to /Users/vscheuber/temp/journeys/PostBody.journey.json
[========================================] 100% | 1/1 | ProgressiveProfile saved to /Users/vscheuber/temp/journeys/ProgressiveProfile.journey.json
[========================================] 100% | 1/1 | ProtectedLogin saved to /Users/vscheuber/temp/journeys/ProtectedLogin.journey.json
[========================================] 100% | 1/1 | Push saved to /Users/vscheuber/temp/journeys/Push.journey.json
[========================================] 100% | 1/1 | PushRegistration saved to /Users/vscheuber/temp/journeys/PushRegistration.journey.json
[========================================] 100% | 1/1 | ReadyEndpoint saved to /Users/vscheuber/temp/journeys/ReadyEndpoint.journey.json
[========================================] 100% | 1/1 | Redirect saved to /Users/vscheuber/temp/journeys/Redirect.journey.json
[========================================] 100% | 1/1 | Registration saved to /Users/vscheuber/temp/journeys/Registration.journey.json
[========================================] 100% | 1/1 | Registration-scp saved to /Users/vscheuber/temp/journeys/Registration-scp.journey.json
[========================================] 100% | 1/1 | ResendOTPTest saved to /Users/vscheuber/temp/journeys/ResendOTPTest.journey.json
[========================================] 100% | 1/1 | ResetPassword saved to /Users/vscheuber/temp/journeys/ResetPassword.journey.json
[========================================] 100% | 1/1 | ResetPassword-Choice saved to /Users/vscheuber/temp/journeys/ResetPassword-Choice.journey.json
[========================================] 100% | 1/1 | ResetPIN saved to /Users/vscheuber/temp/journeys/ResetPIN.journey.json
[========================================] 100% | 1/1 | ResetReplayCredentials saved to /Users/vscheuber/temp/journeys/ResetReplayCredentials.journey.json
[========================================] 100% | 1/1 | Routed_OIDC saved to /Users/vscheuber/temp/journeys/Routed_OIDC.journey.json
[========================================] 100% | 1/1 | Routed_SAML saved to /Users/vscheuber/temp/journeys/Routed_SAML.journey.json
[========================================] 100% | 1/1 | Router saved to /Users/vscheuber/temp/journeys/Router.journey.json
[========================================] 100% | 1/1 | Router2 saved to /Users/vscheuber/temp/journeys/Router2.journey.json
[========================================] 100% | 1/1 | Sample Journey saved to /Users/vscheuber/temp/journeys/Sample-Journey.journey.json
[========================================] 100% | 1/1 | SendEmailTest saved to /Users/vscheuber/temp/journeys/SendEmailTest.journey.json
[========================================] 100% | 1/1 | SessionInfo saved to /Users/vscheuber/temp/journeys/SessionInfo.journey.json
[========================================] 100% | 1/1 | SetupMFA saved to /Users/vscheuber/temp/journeys/SetupMFA.journey.json
[========================================] 100% | 1/1 | Simple saved to /Users/vscheuber/temp/journeys/Simple.journey.json
[========================================] 100% | 1/1 | Social Login saved to /Users/vscheuber/temp/journeys/Social-Login.journey.json
[========================================] 100% | 1/1 | StudentLogin saved to /Users/vscheuber/temp/journeys/StudentLogin.journey.json
[========================================] 100% | 1/1 | Suspend saved to /Users/vscheuber/temp/journeys/Suspend.journey.json
[========================================] 100% | 1/1 | TandC saved to /Users/vscheuber/temp/journeys/TandC.journey.json
[========================================] 100% | 1/1 | temp saved to /Users/vscheuber/temp/journeys/temp.journey.json
[========================================] 100% | 1/1 | TermsAndConditions saved to /Users/vscheuber/temp/journeys/TermsAndConditions.journey.json
[========================================] 100% | 1/1 | ThemeByLanguage saved to /Users/vscheuber/temp/journeys/ThemeByLanguage.journey.json
[========================================] 100% | 1/1 | ThemeByLanguageMulti saved to /Users/vscheuber/temp/journeys/ThemeByLanguageMulti.journey.json
[========================================] 100% | 1/1 | ThemeByPreference saved to /Users/vscheuber/temp/journeys/ThemeByPreference.journey.json
[========================================] 100% | 1/1 | ThemeByProfileData saved to /Users/vscheuber/temp/journeys/ThemeByProfileData.journey.json
[========================================] 100% | 1/1 | ThemedMFALogin saved to /Users/vscheuber/temp/journeys/ThemedMFALogin.journey.json
[========================================] 100% | 1/1 | Themes saved to /Users/vscheuber/temp/journeys/Themes.journey.json
[========================================] 100% | 1/1 | TwilioIVR saved to /Users/vscheuber/temp/journeys/TwilioIVR.journey.json
[========================================] 100% | 1/1 | TxAuthZ saved to /Users/vscheuber/temp/journeys/TxAuthZ.journey.json
[========================================] 100% | 1/1 | UpdatePassword saved to /Users/vscheuber/temp/journeys/UpdatePassword.journey.json
[========================================] 100% | 1/1 | UpdatePersonalData saved to /Users/vscheuber/temp/journeys/UpdatePersonalData.journey.json
[========================================] 100% | 1/1 | UpdateUsername saved to /Users/vscheuber/temp/journeys/UpdateUsername.journey.json
[========================================] 100% | 1/1 | WebAuthN saved to /Users/vscheuber/temp/journeys/WebAuthN.journey.json
[========================================] 100% | 1/1 | WebAuthNRegistration saved to /Users/vscheuber/temp/journeys/WebAuthNRegistration.journey.json
[========================================] 100% | 1/1 | ZeroTrust saved to /Users/vscheuber/temp/journeys/ZeroTrust.journey.json
%

With scripts you have additional options to export as JSON (default) or as JSON formatted as string array with the --use-string-arrays option (better for diff operations in version control systems) and even export the script itself into its own .js or .groovy file using -x, --extract option to make it easier to modify the scripts in an IDE.

When using -x, --extract on export, you may want to consider using -w, --watch on script import to allow you to edit scripts in your IDE and have frodo pick up your changes on save and import them (if they compile) into your deployment.

[dieterdanger]

Hello Volker,
thank you so much for your answer. I didn't know the -x option for scripts.

With respect to my initial request. I must have mixed something up after a long working day :-) Of course, the output of journey/script exports is json.

What I've meant was the output of the 'describe' command for journeys or authn respectively. My problem with the default output of these commands is that they are difficult to process in scripting languages like bash. One problem is that the output contains ASCII-chars for color codes. If it would be possible to output the results in JSON format, I'd use something like jq to process it.

I have two additional question, for which maybe you got an answer too:

• Is it possible to do a full export of a journey with all inner trees recursively and all scripts including libraries? In my tests, inner trees as well as referenced libaries won't get exported.
• I'm looking for a way to duplicate journeys / scripts with frodo-cli (without amster or REST). For scripts I can use the --re-uuid coupled with -n newname. What can I do for journeys? Is it sufficient to rename the journey in the .json-output before importing and to use --re-uuid, too?

Best regards
Dennis