Appendix: Sample /upgrades/{upgradeId} API Responses

Example 1: A Flow Compatible with Hosted Login v1

The following API response comes from running the /{upgradeId} endpoint against a flow that is already compatible with Hosted Login v1:

 "itemsToAdd": [
        "2faMessages",
        "fields.textReturnToRp",
        "fields.textPasswordTitle",
        "fields.textEmailTitle",
        "fields.textAddEmailTitle",
        "fields.textChangeEmailTitle",
        "fields.textChangeEmailValue",
        "fields.textEmailVerified",
        "fields.textChangeEmailFormValue",
        "fields.textChangeEmailPlaceholder",
        "fields.textEmailLabel",
        "fields.textChangeEmailSubmit",
        "fields.textChangeEmailConfirmTitle",
        "fields.textChangeEmailConfirmValue",
        "fields.textChangeEmailCodePlaceholder",
        "fields.textChangeEmailCodeLabel",
        "fields.textChangeEmailCodeCodeSubmit",
        "fields.textSecondFactorChangeEmailCodeResend",
        "fields.textSecondFactorChangeEmailCodeSendLink",
        "fields.textSecondFactorChangeEmailCodeResendInvalid",
        "fields.textSecondFactorChangeEmailCodeSendLinkInvalid",
        "fields.textChangeEmailCodeCodeSuccess",
        "fields.textMobileNumberTitle",
        "fields.textAddMobileNumberTitle",
        "fields.textChangeMobileNumberTitle",
        "fields.textChangeMobileNumberValue",
        "fields.textMobileNumberVerified",
        "fields.textChangeMobileNumberFormValue",
        "fields.textMobileNumberLabel",
        "fields.textChangeMobileNumberPlaceholder",
        "fields.textChangeMobileNumberSubmit",
        "fields.textChangeMobileNumberConfirmTitle",
        "fields.textChangeMobileNumberConfirmValue",
        "fields.textChangeMobileNumberCodePlaceholder",
        "fields.textChangeMobileNumberCodeLabel",
        "fields.textChangeMobileNumberCodeCodeSubmit",
        "fields.textSecondFactorChangeMobileNumberCodeResend",
        "fields.textSecondFactorChangeMobileNumberCodeSendLink",
        "fields.textSecondFactorChangeMobileNumberCodeResendInvalid",
        "fields.textSecondFactorChangeMobileNumberCodeSendLinkInvalid",
        "fields.textChangeMobileNumberCodeCodeSuccess",
        "fields.textDeleteMobileNumberTitle",
        "fields.textDeleteMobileNumberValue",
        "fields.textDeleteMobileNumberYes",
        "fields.textDeleteMobileNumberNo",
        "fields.textWelcomeMessage",
        "fields.textRegistrationRedirectToSignInText",
        "fields.textRegistrationRedirectToSignInLink",
        "fields.textResetPasswordRedirectToSignInText",
        "fields.textResetPasswordRedirectToSignInLink",
        "fields.textResetPasswordResendText",
        "fields.textResetPasswordResendLink",
        "fields.textAuthRuleSecondFactorHeading",
        "fields.textAuthRuleSecondFactorValue",
        "fields.textAuthRuleSecondFactorActionTitle",
        "fields.textAuthRuleSecondFactorEmailCodeTitle",
        "fields.textAuthRuleSecondFactorSmsCodeTitle",
        "fields.textSecondFactorSentSuccessful",
        "fields.textAuthRuleSecondFactorActionError",
        "fields.textAuthRuleSecondFactorRegistrationHeading",
        "fields.textAuthRuleSecondFactorRegistrationValue",
        "fields.textAuthRuleSecondFactorRegistrationActionTitle",
        "fields.textAuthRuleSecondFactorRegistrationEmailCodeTitle",
        "fields.textAuthRuleSecondFactorRegistrationSmsCodeTitle",
        "fields.textAuthRuleSecondFactorRegistrationActionError",
        "fields.textAuthRuleSecondFactorLoginCodeHeading",
        "fields.textAuthRuleSecondFactorLoginCodeValue",
        "fields.textAuthRuleSecondFactorLoginCodeActionTitle",
        "fields.textAuthRuleSecondFactorLoginCodePlaceholder",
        "fields.textAuthRuleSecondFactorLoginCodeSubmit",
        "fields.textSecondFactorLoginCodeResend",
        "fields.textSecondFactorLoginCodeSendLink",
        "fields.textSecondFactorLoginCodeResendInvalid",
        "fields.textSecondFactorLoginCodeResendInvalidLink",
        "fields.textAuthRuleSecondFactorRegistrationCodeHeading",
        "fields.textAuthRuleSecondFactorRegistrationCodeValue",
        "fields.textAuthRuleSecondFactorRegistrationCodeActionTitle",
        "fields.textAuthRuleSecondFactorRegistrationCodePlaceholder",
        "fields.textAuthRuleSecondFactorRegistrationCodeSubmit",
        "fields.textSecondFactorRegistrationCodeResend",
        "fields.textSecondFactorRegistrationCodeSendLink",
        "fields.textSecondFactorRegistrationCodeResendInvalid",
        "fields.textSecondFactorRegistrationCodeResendInvalidLink",
        "fields.textAuthRuleSecondFactorRememberDevice",
        "fields.textErrorEmailUnique",
        "fields.textErrorEmailFormat",
        "fields.textErrorMobileNumberUnique",
        "fields.textErrorMobileNumberFormat",
        "fields.textErrorMobileNumberFormatShort",
        "fields.textErrorMobileNumberFormatLong",
        "fields.textErrorMobileNumberFormatCountryCode",
        "fields.textErrorMobileNumberInvalid",
        "fields.textErrorEmailInvalid",
        "fields.textErrorMobileNumberStoredInvalid",
        "fields.textErrorEmailStoredInvalid"
    ],
    "itemsToDelete": [
        "fields.traditionalRegistrationForm.next"
    ]
}


Example 2: A Flow Compatible with Hosted Login v1

The following API response comes from running the /{upgradeId} endpoint against an older Identity Cloud flow that is not compatible with Hosted Login v1:

{
    "itemsToAdd": [
        "2faMessages",
        "fields.dataEmailAddress",
        "fields.dataDisplayName",
        "fields.dataUserPhotos",
        "fields.dataUserSocialProfileProviders",
        "fields.dataUserSocialProfilePhotos",
        "fields.textLogout",
        "fields.textReturnToRp",
        "fields.textAcceptanceBlurb",
        "fields.textBackToUserProfile",
        "fields.textLoginSuccessful",
        "fields.textLogoutSuccessful",
        "fields.textRegistrationSuccessful",
        "fields.textRegistrationCancel",
        "fields.textNeedHelp",
        "fields.textSaveChanges",
        "fields.textPersonalData",
        "fields.textPersonalDataSectionDescription",
        "fields.textAccountSecurity",
        "fields.textAccountSecuritySectionDescription",
        "fields.textPasswordTitle",
        "fields.textPasswordSettings",
        "fields.textEmailTitle",
        "fields.textAddEmailTitle",
        "fields.textChangeEmailTitle",
        "fields.textChangeEmailValue",
        "fields.textEmailVerified",
        "fields.textChangeEmailFormValue",
        "fields.textChangeEmailPlaceholder",
        "fields.textEmailLabel",
        "fields.textChangeEmailSubmit",
        "fields.textChangeEmailConfirmTitle",
        "fields.textChangeEmailConfirmValue",
        "fields.textChangeEmailCodePlaceholder",
        "fields.textChangeEmailCodeLabel",
        "fields.textChangeEmailCodeCodeSubmit",
        "fields.textSecondFactorChangeEmailCodeResend",
        "fields.textSecondFactorChangeEmailCodeSendLink",
        "fields.textSecondFactorChangeEmailCodeResendInvalid",
        "fields.textSecondFactorChangeEmailCodeSendLinkInvalid",
        "fields.textChangeEmailCodeCodeSuccess",
        "fields.textMobileNumberTitle",
        "fields.textAddMobileNumberTitle",
        "fields.textChangeMobileNumberTitle",
        "fields.textChangeMobileNumberValue",
        "fields.textMobileNumberVerified",
        "fields.textChangeMobileNumberFormValue",
        "fields.textMobileNumberLabel",
        "fields.textChangeMobileNumberPlaceholder",
        "fields.textChangeMobileNumberSubmit",
        "fields.textChangeMobileNumberConfirmTitle",
        "fields.textChangeMobileNumberConfirmValue",
        "fields.textChangeMobileNumberCodePlaceholder",
        "fields.textChangeMobileNumberCodeLabel",
        "fields.textChangeMobileNumberCodeCodeSubmit",
        "fields.textSecondFactorChangeMobileNumberCodeResend",
        "fields.textSecondFactorChangeMobileNumberCodeSendLink",
        "fields.textSecondFactorChangeMobileNumberCodeResendInvalid",
        "fields.textSecondFactorChangeMobileNumberCodeSendLinkInvalid",
        "fields.textChangeMobileNumberCodeCodeSuccess",
        "fields.textDeleteMobileNumberTitle",
        "fields.textDeleteMobileNumberValue",
        "fields.textDeleteMobileNumberYes",
        "fields.textDeleteMobileNumberNo",
        "fields.textLinkAccountsSettings",
        "fields.textLinkAccountsDescription",
        "fields.textPrivacySettings",
        "fields.textPrivacySettingsSectionDescription",
        "fields.textAccountScreensHeading",
        "fields.textSignInScreenHeading",
        "fields.textWelcomeMessage",
        "fields.textSignInScreenSubHeading",
        "fields.textSignInCancel",
        "fields.textNeedAnAccount",
        "fields.textRegistrationRedirectToSignInText",
        "fields.textRegistrationRedirectToSignInLink",
        "fields.textResetPasswordRedirectToSignInText",
        "fields.textResetPasswordRedirectToSignInLink",
        "fields.textSignUp",
        "fields.textSignIn",
        "fields.textCreateNewAccount",
        "fields.textCreateNewAccountSubHeading",
        "fields.textCreateNewAccountSocialSubHeading",
        "fields.textCreateNewAccountTraditionalSubHeading",
        "fields.textCreateAccount",
        "fields.textSignInAlternativeCredentials",
        "fields.textCompleteYourRegistration",
        "fields.textConnectWith",
        "fields.textVerifyIdentity",
        "fields.textExistingAccountFound",
        "fields.textJustSignedInWithProvider",
        "fields.textVerifyWithProviderToMerge",
        "fields.textMergeAccountAuthScreenHeading",
        "fields.textMergeAccountAuthScreenSubHeading",
        "fields.textForgotPassword",
        "fields.textResetPasswordRequestScreenHeading",
        "fields.textResetPasswordDisabled",
        "fields.textResetPasswordRequestCodeSuccess",
        "fields.textResetPasswordResendText",
        "fields.textResetPasswordResendLink",
        "fields.textResetPasswordRequestSubmit",
        "fields.textResetPasswordSendTo",
        "fields.textResetPasswordScreenHeading",
        "fields.textResetPasswordSuccessScreenHeading",
        "fields.textResetPasswordSuccess",
        "fields.textUpdatePassword",
        "fields.textResetPasswordUnrecognizedCode",
        "fields.textVerifyEmailScreenHeading",
        "fields.textVerifyEmailFailure",
        "fields.textVerifyEmailRequestSubmit",
        "fields.textResendVerificationSuccessScreenHeading",
        "fields.textResendVerificationSuccess",
        "fields.textVerifyEmailSuccessScreenHeading",
        "fields.textVerifyEmailSuccess",
        "fields.textVerifyEmailDisabled",
        "fields.textDeleteAccountHeader",
        "fields.textDeleteAccountMessage",
        "fields.textDeleteAccountConfirm",
        "fields.textDeleteAccountButton",
        "fields.textDeleteAccountSuccessful",
        "fields.textAccountActions",
        "fields.textRequestDataHeader",
        "fields.textRequestDataMessage",
        "fields.textRequestDataButton",
        "fields.textRequestDataSuccessful",
        "fields.textVerifyEmailAuthRule",
        "fields.textAuthRuleRequiredAttributesHeading",
        "fields.textAuthRuleRequiredAttributesValue",
        "fields.textAuthRuleRequiredAttributesSubmit",
        "fields.textAuthRuleSecondFactorHeading",
        "fields.textAuthRuleSecondFactorValue",
        "fields.textAuthRuleSecondFactorActionTitle",
        "fields.textAuthRuleSecondFactorEmailCodeTitle",
        "fields.textAuthRuleSecondFactorSmsCodeTitle",
        "fields.textSecondFactorSentSuccessful",
        "fields.textAuthRuleSecondFactorActionError",
        "fields.textAuthRuleSecondFactorRegistrationHeading",
        "fields.textAuthRuleSecondFactorRegistrationValue",
        "fields.textAuthRuleSecondFactorRegistrationActionTitle",
        "fields.textAuthRuleSecondFactorRegistrationEmailCodeTitle",
        "fields.textAuthRuleSecondFactorRegistrationSmsCodeTitle",
        "fields.textAuthRuleSecondFactorRegistrationActionError",
        "fields.textProfileSaveSuccessful",
        "fields.textAuthRuleConsentsHeading",
        "fields.textAuthRuleConsentsValue",
        "fields.textAuthRuleConsentsSubmit",
        "fields.textAuthRuleLegalAcceptanceHeading",
        "fields.textAuthRuleLegalAcceptanceValue",
        "fields.textAuthRuleLegalAcceptanceSubmit",
        "fields.textAuthRuleSecondFactorLoginCodeHeading",
        "fields.textAuthRuleSecondFactorLoginCodeValue",
        "fields.textAuthRuleSecondFactorLoginCodeActionTitle",
        "fields.textAuthRuleSecondFactorLoginCodePlaceholder",
        "fields.textAuthRuleSecondFactorLoginCodeSubmit",
        "fields.textSecondFactorLoginCodeResend",
        "fields.textSecondFactorLoginCodeSendLink",
        "fields.textSecondFactorLoginCodeResendInvalid",
        "fields.textSecondFactorLoginCodeResendInvalidLink",
        "fields.textAuthRuleSecondFactorRegistrationCodeHeading",
        "fields.textAuthRuleSecondFactorRegistrationCodeValue",
        "fields.textAuthRuleSecondFactorRegistrationCodeActionTitle",
        "fields.textAuthRuleSecondFactorRegistrationCodePlaceholder",
        "fields.textAuthRuleSecondFactorRegistrationCodeSubmit",
        "fields.textSecondFactorRegistrationCodeResend",
        "fields.textSecondFactorRegistrationCodeSendLink",
        "fields.textSecondFactorRegistrationCodeResendInvalid",
        "fields.textSecondFactorRegistrationCodeResendInvalidLink",
        "fields.textAuthRuleSecondFactorRememberDevice",
        "fields.textCancelRequest",
        "fields.textFooter",
        "fields.textFooterExtra",
        "fields.textVisitingMessage",
        "fields.textErrorEmailUnique",
        "fields.textErrorEmailFormat",
        "fields.textErrorMobileNumberUnique",
        "fields.textErrorMobileNumberFormat",
        "fields.textErrorMobileNumberFormatShort",
        "fields.textErrorMobileNumberFormatLong",
        "fields.textErrorMobileNumberFormatCountryCode",
        "fields.textErrorMobileNumberInvalid",
        "fields.textErrorEmailInvalid",
        "fields.textErrorMobileNumberStoredInvalid",
        "fields.textErrorEmailStoredInvalid",
        "fields.linkHelp",
        "fields.linkTermsOfService",
        "fields.linkPrivacyPolicy"
    ],
    "itemsToDelete": []
}